Release 4
AdministrationThis page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for observationdefinition
{
"resourceType" : "StructureDefinition",
"id" : "ObservationDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Definitional Artifacts"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"version" : "4.0.1",
"name" : "ObservationDefinition",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
"purpose" : "In a catalog of health-related services that use or produce observations and measurements, this resource describes the expected characteristics of these observation / measurements.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ObservationDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ObservationDefinition",
"path" : "ObservationDefinition",
"short" : "Definition of an observation",
"definition" : "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
"comment" : "An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "OM2\nOM3\nOMC"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "ObservationDefinition.id",
"path" : "ObservationDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.meta",
"path" : "ObservationDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.implicitRules",
"path" : "ObservationDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ObservationDefinition.language",
"path" : "ObservationDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ObservationDefinition.text",
"path" : "ObservationDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ObservationDefinition.contained",
"path" : "ObservationDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.extension",
"path" : "ObservationDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.modifierExtension",
"path" : "ObservationDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.category",
"path" : "ObservationDefinition.category",
"short" : "Category of observation",
"definition" : "A code that classifies the general type of observation.",
"comment" : "This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what kinds of observations are retrieved and displayed.",
"alias" : ["Class of observation"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCategory"
}],
"strength" : "example",
"description" : "Codes for high level observation categories.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"DEF\"].code"
}]
},
{
"id" : "ObservationDefinition.code",
"path" : "ObservationDefinition.code",
"short" : "Type of observation (code / type)",
"definition" : "Describes what will be observed. Sometimes this is called the observation \"name\".",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OM1-2\nOMC-4"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "ObservationDefinition.identifier",
"path" : "ObservationDefinition.identifier",
"short" : "Business identifier for this ObservationDefinition instance",
"definition" : "A unique identifier assigned to this ObservationDefinition artifact.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.permittedDataType",
"path" : "ObservationDefinition.permittedDataType",
"short" : "Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period",
"definition" : "The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.permittedDataType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationDataType"
}],
"strength" : "required",
"description" : "Permitted data type for observation value.",
"valueSet" : "http://hl7.org/fhir/ValueSet/permitted-data-type|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-3"
}]
},
{
"id" : "ObservationDefinition.multipleResultsAllowed",
"path" : "ObservationDefinition.multipleResultsAllowed",
"short" : "Multiple results allowed",
"definition" : "Multiple results allowed for observations conforming to this ObservationDefinition.",
"comment" : "An example of observation allowing multiple results is \"bacteria identified by culture\". Conversely, the measurement of a potassium level allows a single result.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.multipleResultsAllowed",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : true
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.method",
"path" : "ObservationDefinition.method",
"short" : "Method used to produce the observation",
"definition" : "The method or technique used to perform the observation.",
"comment" : "Only used if not implicit in observation code.",
"requirements" : "In some cases, method can impact results.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationMethod"
}],
"strength" : "example",
"description" : "Methods for simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-14"
},
{
"identity" : "rim",
"map" : "methodCode"
}]
},
{
"id" : "ObservationDefinition.preferredReportName",
"path" : "ObservationDefinition.preferredReportName",
"short" : "Preferred report name",
"definition" : "The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.preferredReportName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM1-9"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails",
"path" : "ObservationDefinition.quantitativeDetails",
"short" : "Characteristics of quantitative results",
"definition" : "Characteristics for quantitative results of this observation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.id",
"path" : "ObservationDefinition.quantitativeDetails.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.extension",
"path" : "ObservationDefinition.quantitativeDetails.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.modifierExtension",
"path" : "ObservationDefinition.quantitativeDetails.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"path" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"short" : "Customary unit for quantitative results",
"definition" : "Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.unit",
"path" : "ObservationDefinition.quantitativeDetails.unit",
"short" : "SI unit for quantitative results",
"definition" : "SI unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.unit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-4"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"path" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"short" : "SI to Customary unit conversion factor",
"definition" : "Factor for converting value expressed with SI unit to value expressed with customary unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2-5"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"path" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"short" : "Decimal precision of observation quantitative results",
"definition" : "Number of digits after decimal separator when the results of such observations are of type Quantity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2-3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval",
"path" : "ObservationDefinition.qualifiedInterval",
"short" : "Qualified range for continuous and ordinal observation results",
"definition" : "Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2-6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.id",
"path" : "ObservationDefinition.qualifiedInterval.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.extension",
"path" : "ObservationDefinition.qualifiedInterval.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.modifierExtension",
"path" : "ObservationDefinition.qualifiedInterval.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.category",
"path" : "ObservationDefinition.qualifiedInterval.category",
"short" : "reference | critical | absolute",
"definition" : "The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "critical"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeCategory"
}],
"strength" : "required",
"description" : "Codes identifying the category of observation range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-range-category|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.range",
"path" : "ObservationDefinition.qualifiedInterval.range",
"short" : "The interval itself, for continuous or ordinal observations",
"definition" : "The low and high values determining the interval. There may be only one of the two.",
"requirements" : "The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.range",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.context",
"path" : "ObservationDefinition.qualifiedInterval.context",
"short" : "Range context qualifier",
"definition" : "Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeMeaning"
}],
"strength" : "extensible",
"description" : "Code identifying the health context of a range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning"
},
"mapping" : [{
"identity" : "v2",
"map" : "n.a."
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.appliesTo",
"path" : "ObservationDefinition.qualifiedInterval.appliesTo",
"short" : "Targetted population of the range",
"definition" : "Codes to indicate the target population this reference range applies to.",
"comment" : "If this element is not present then the global population is assumed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.appliesTo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeAppliesTo"
}],
"strength" : "example",
"description" : "Codes identifying the population the reference range applies to.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gender",
"path" : "ObservationDefinition.qualifiedInterval.gender",
"short" : "male | female | other | unknown",
"definition" : "Sex of the population the range applies to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.gender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "female"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.age",
"path" : "ObservationDefinition.qualifiedInterval.age",
"short" : "Applicable age range, if relevant",
"definition" : "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"comment" : "Some analytes vary greatly over age.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.age",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RFR.3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"path" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"short" : "Applicable gestational age range, if relevant",
"definition" : "The gestational age to which this reference range is applicable, in the context of pregnancy.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RFR.4"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.condition",
"path" : "ObservationDefinition.qualifiedInterval.condition",
"short" : "Condition associated with the reference range",
"definition" : "Text based condition for which the reference range is valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.condition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RFR.7"
}]
},
{
"id" : "ObservationDefinition.validCodedValueSet",
"path" : "ObservationDefinition.validCodedValueSet",
"short" : "Value set of valid coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of valid coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.validCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-3"
}]
},
{
"id" : "ObservationDefinition.normalCodedValueSet",
"path" : "ObservationDefinition.normalCodedValueSet",
"short" : "Value set of normal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of normal coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.normalCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-4"
}]
},
{
"id" : "ObservationDefinition.abnormalCodedValueSet",
"path" : "ObservationDefinition.abnormalCodedValueSet",
"short" : "Value set of abnormal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of abnormal coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.abnormalCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-5"
}]
},
{
"id" : "ObservationDefinition.criticalCodedValueSet",
"path" : "ObservationDefinition.criticalCodedValueSet",
"short" : "Value set of critical coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of critical coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.criticalCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-6"
}]
}]
},
"differential" : {
"element" : [{
"id" : "ObservationDefinition",
"path" : "ObservationDefinition",
"short" : "Definition of an observation",
"definition" : "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
"comment" : "An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "OM2\nOM3\nOMC"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "ObservationDefinition.category",
"path" : "ObservationDefinition.category",
"short" : "Category of observation",
"definition" : "A code that classifies the general type of observation.",
"comment" : "This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what kinds of observations are retrieved and displayed.",
"alias" : ["Class of observation"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCategory"
}],
"strength" : "example",
"description" : "Codes for high level observation categories.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"DEF\"].code"
}]
},
{
"id" : "ObservationDefinition.code",
"path" : "ObservationDefinition.code",
"short" : "Type of observation (code / type)",
"definition" : "Describes what will be observed. Sometimes this is called the observation \"name\".",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OM1-2\nOMC-4"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "ObservationDefinition.identifier",
"path" : "ObservationDefinition.identifier",
"short" : "Business identifier for this ObservationDefinition instance",
"definition" : "A unique identifier assigned to this ObservationDefinition artifact.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.permittedDataType",
"path" : "ObservationDefinition.permittedDataType",
"short" : "Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period",
"definition" : "The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationDataType"
}],
"strength" : "required",
"description" : "Permitted data type for observation value.",
"valueSet" : "http://hl7.org/fhir/ValueSet/permitted-data-type|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-3"
}]
},
{
"id" : "ObservationDefinition.multipleResultsAllowed",
"path" : "ObservationDefinition.multipleResultsAllowed",
"short" : "Multiple results allowed",
"definition" : "Multiple results allowed for observations conforming to this ObservationDefinition.",
"comment" : "An example of observation allowing multiple results is \"bacteria identified by culture\". Conversely, the measurement of a potassium level allows a single result.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : true
}]
},
{
"id" : "ObservationDefinition.method",
"path" : "ObservationDefinition.method",
"short" : "Method used to produce the observation",
"definition" : "The method or technique used to perform the observation.",
"comment" : "Only used if not implicit in observation code.",
"requirements" : "In some cases, method can impact results.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationMethod"
}],
"strength" : "example",
"description" : "Methods for simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-14"
},
{
"identity" : "rim",
"map" : "methodCode"
}]
},
{
"id" : "ObservationDefinition.preferredReportName",
"path" : "ObservationDefinition.preferredReportName",
"short" : "Preferred report name",
"definition" : "The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM1-9"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails",
"path" : "ObservationDefinition.quantitativeDetails",
"short" : "Characteristics of quantitative results",
"definition" : "Characteristics for quantitative results of this observation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"path" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"short" : "Customary unit for quantitative results",
"definition" : "Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.unit",
"path" : "ObservationDefinition.quantitativeDetails.unit",
"short" : "SI unit for quantitative results",
"definition" : "SI unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-4"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"path" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"short" : "SI to Customary unit conversion factor",
"definition" : "Factor for converting value expressed with SI unit to value expressed with customary unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2-5"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"path" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"short" : "Decimal precision of observation quantitative results",
"definition" : "Number of digits after decimal separator when the results of such observations are of type Quantity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2-3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval",
"path" : "ObservationDefinition.qualifiedInterval",
"short" : "Qualified range for continuous and ordinal observation results",
"definition" : "Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2-6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.category",
"path" : "ObservationDefinition.qualifiedInterval.category",
"short" : "reference | critical | absolute",
"definition" : "The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "critical"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeCategory"
}],
"strength" : "required",
"description" : "Codes identifying the category of observation range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-range-category|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.range",
"path" : "ObservationDefinition.qualifiedInterval.range",
"short" : "The interval itself, for continuous or ordinal observations",
"definition" : "The low and high values determining the interval. There may be only one of the two.",
"requirements" : "The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.context",
"path" : "ObservationDefinition.qualifiedInterval.context",
"short" : "Range context qualifier",
"definition" : "Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeMeaning"
}],
"strength" : "extensible",
"description" : "Code identifying the health context of a range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning"
},
"mapping" : [{
"identity" : "v2",
"map" : "n.a."
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.appliesTo",
"path" : "ObservationDefinition.qualifiedInterval.appliesTo",
"short" : "Targetted population of the range",
"definition" : "Codes to indicate the target population this reference range applies to.",
"comment" : "If this element is not present then the global population is assumed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeAppliesTo"
}],
"strength" : "example",
"description" : "Codes identifying the population the reference range applies to.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gender",
"path" : "ObservationDefinition.qualifiedInterval.gender",
"short" : "male | female | other | unknown",
"definition" : "Sex of the population the range applies to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "female"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.age",
"path" : "ObservationDefinition.qualifiedInterval.age",
"short" : "Applicable age range, if relevant",
"definition" : "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"comment" : "Some analytes vary greatly over age.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}],
"mapping" : [{
"identity" : "v2",
"map" : "RFR.3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"path" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"short" : "Applicable gestational age range, if relevant",
"definition" : "The gestational age to which this reference range is applicable, in the context of pregnancy.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}],
"mapping" : [{
"identity" : "v2",
"map" : "RFR.4"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.condition",
"path" : "ObservationDefinition.qualifiedInterval.condition",
"short" : "Condition associated with the reference range",
"definition" : "Text based condition for which the reference range is valid.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "RFR.7"
}]
},
{
"id" : "ObservationDefinition.validCodedValueSet",
"path" : "ObservationDefinition.validCodedValueSet",
"short" : "Value set of valid coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of valid coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-3"
}]
},
{
"id" : "ObservationDefinition.normalCodedValueSet",
"path" : "ObservationDefinition.normalCodedValueSet",
"short" : "Value set of normal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of normal coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-4"
}]
},
{
"id" : "ObservationDefinition.abnormalCodedValueSet",
"path" : "ObservationDefinition.abnormalCodedValueSet",
"short" : "Value set of abnormal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of abnormal coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-5"
}]
},
{
"id" : "ObservationDefinition.criticalCodedValueSet",
"path" : "ObservationDefinition.criticalCodedValueSet",
"short" : "Value set of critical coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of critical coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-6"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 (Technical Correction #1) (v4.0.1) generated on Fri, Nov 1, 2019 09:36+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to R3 |
|
Propose a change