Release 5 Preview #1
AdministrationThis page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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-12-31T21:03:40.621+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"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.2.0",
"name" : "ObservationDefinition",
"status" : "draft",
"date" : "2019-12-31T21:03:40+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.2.0",
"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" : "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" : "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" : "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" : "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" : "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",
"valueUri" : "id"
}],
"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" : "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" : "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" : "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" : "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" : "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" : "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" : "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" : "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.url",
"path" : "ObservationDefinition.url",
"short" : "Logical canonical URL to reference this ObservationDefinition (globally unique)",
"definition" : "An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.",
"comment" : "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.",
"requirements" : "Allows the ObservationDefinition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.url",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.identifier",
"path" : "ObservationDefinition.identifier",
"short" : "Business identifier of the ObservationDefinition",
"definition" : "Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.",
"requirements" : "Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.identifier",
"min" : 0,
"max" : "1"
},
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.version",
"path" : "ObservationDefinition.version",
"short" : "Business version of the ObservationDefinition",
"definition" : "The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.",
"comment" : "There may be multiple different instances of a ObservationDefinition that have the same identifier but different versions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.version",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.title",
"path" : "ObservationDefinition.title",
"short" : "Name for this ObservationDefinition (Human friendly)",
"definition" : "A short, descriptive, user-friendly title for the ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.title",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.derivedFromCanonical",
"path" : "ObservationDefinition.derivedFromCanonical",
"short" : "Based on FHIR definition of another observation",
"definition" : "The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.derivedFromCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.derivedFromUri",
"path" : "ObservationDefinition.derivedFromUri",
"short" : "Based on external definition",
"definition" : "The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.",
"requirements" : "Observation definitions may be refinements of other definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.derivedFromUri",
"min" : 0,
"max" : "*"
},
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.status",
"path" : "ObservationDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The current state of the ObservationDefinition.",
"comment" : "A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation\nUnknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.status",
"min" : 1,
"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" : "Element"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
}],
"strength" : "required",
"description" : "Codes identifying the state of an ObservationDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.2.0"
}
},
{
"id" : "ObservationDefinition.experimental",
"path" : "ObservationDefinition.experimental",
"short" : "If for testing purposes, not real usage",
"definition" : "A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of ObservationDefinition that are appropriate for use vs. not.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"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" : "Element"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true
},
{
"id" : "ObservationDefinition.subject[x]",
"path" : "ObservationDefinition.subject[x]",
"short" : "Type of subject for the defined observation",
"definition" : "A code or group definition that describes the intended subject of Observation instances conforming to this ObservationDefinition.",
"comment" : "Examples: person, animal, device, air, surface ….",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.subject[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.date",
"path" : "ObservationDefinition.date",
"short" : "Date status first applied",
"definition" : "For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.publisher",
"path" : "ObservationDefinition.publisher",
"short" : "The name of the individual or organization that published the ObservationDefinition",
"definition" : "Helps establish the \"authority/credibility\" of the ObservationDefinition. May also allow for contact.",
"requirements" : "Usually an organization, but may be an individual. The publisher (or steward) of the ObservationDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the ObservationDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the ObservationDefinition. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.contact",
"path" : "ObservationDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.description",
"path" : "ObservationDefinition.description",
"short" : "Natural language description of the ObservationDefinition",
"definition" : "A free text natural language description of the ObservationDefinition from the consumer's perspective.",
"comment" : "This description can be used to capture details such as why the ObservationDefinition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.useContext",
"path" : "ObservationDefinition.useContext",
"short" : "Content intends to support these contexts",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of observation definitions.",
"comment" : "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.jurisdiction",
"path" : "ObservationDefinition.jurisdiction",
"short" : "Intended jurisdiction for this ObservationDefinition (if applicable)",
"definition" : "A jurisdiction in which the ObservationDefinition is intended to be used.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.jurisdiction",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
}],
"strength" : "extensible",
"description" : "Codes for country, country subdivision and region for indicating where a resource is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
{
"id" : "ObservationDefinition.purpose",
"path" : "ObservationDefinition.purpose",
"short" : "Why this ObservationDefinition is defined",
"definition" : "Explains why this ObservationDefinition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.copyright",
"path" : "ObservationDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.",
"requirements" : "Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.approvalDate",
"path" : "ObservationDefinition.approvalDate",
"short" : "When ObservationDefinition was approved by publisher",
"definition" : "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.lastReviewDate",
"path" : "ObservationDefinition.lastReviewDate",
"short" : "Last review date for the ObservationDefinition",
"definition" : "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comment" : "If specified, this is usually after the approval date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.effectivePeriod",
"path" : "ObservationDefinition.effectivePeriod",
"short" : "The effective date range for the ObservationDefinition",
"definition" : "The period during which the ObservationDefinition content was or is planned to be effective.",
"comment" : "The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation intended to be used for the year 2020 would be published in 2019.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.performerType",
"path" : "ObservationDefinition.performerType",
"short" : "Desired kind of performer for such kind of observation",
"definition" : "The type of individual/organization/device that is expected to act upon instances of this definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.performerType",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"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" : "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",
"definition" : "Describes what will be observed. Sometimes this is called the observation \"name\".",
"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" : "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.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" : "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.2.0"
},
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.bodySite",
"path" : "ObservationDefinition.bodySite",
"short" : "Body part to be observed",
"definition" : "The site on the subject's body where the observation is to be made.",
"comment" : "Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. \nExample: 14975008 |Forearm structure|.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.bodySite",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationBodySite"
}],
"strength" : "example",
"description" : "SNOMED CT body structures.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "rim",
"map" : "targetSiteCode"
}]
},
{
"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\nExample: 702659008 |Automated count technique|.",
"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" : "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.specimen",
"path" : "ObservationDefinition.specimen",
"short" : "Kind of specimen used by this type of observation",
"definition" : "The kind of specimen that this type of observation is produced on.",
"comment" : "Only used for in vitro observations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.specimen",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"]
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "participation[typeCode=SPC].specimen"
}]
},
{
"id" : "ObservationDefinition.device",
"path" : "ObservationDefinition.device",
"short" : "Measurement device",
"definition" : "The measurement device used to produce observations of this type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.device",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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" : "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" : "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",
"valueUri" : "id"
}],
"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" : "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" : "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" : "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" : "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" : "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" : "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" : "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" : "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" : "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",
"valueUri" : "id"
}],
"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" : "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" : "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" : "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" : "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" : "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.2.0"
},
"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" : "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" : "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" : "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" : "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.2.0"
},
"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" : "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" : "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" : "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" : "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" : "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" : "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" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-6"
}]
},
{
"id" : "ObservationDefinition.hasMember",
"path" : "ObservationDefinition.hasMember",
"short" : "Definitions of related resources belonging to this kind of observation group",
"definition" : "This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.hasMember",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.component",
"path" : "ObservationDefinition.component",
"short" : "Component results",
"definition" : "Some observations have multiple component observations, expressed as separate code value pairs.",
"requirements" : "Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.component",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=COMP]"
}]
},
{
"id" : "ObservationDefinition.component.id",
"path" : "ObservationDefinition.component.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",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.component.extension",
"path" : "ObservationDefinition.component.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" : "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" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.component.modifierExtension",
"path" : "ObservationDefinition.component.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" : "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" : "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.component.code",
"path" : "ObservationDefinition.component.code",
"short" : "Type of observation",
"definition" : "Describes what will be observed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.component.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" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"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" : "rim",
"map" : "code"
}]
},
{
"id" : "ObservationDefinition.component.permittedDataType",
"path" : "ObservationDefinition.component.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 of this component observations.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.component.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" : "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.2.0"
}
},
{
"id" : "ObservationDefinition.component.quantitativeDetails",
"path" : "ObservationDefinition.component.quantitativeDetails",
"short" : "Quantitative details",
"definition" : "The quantitative details specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.component.quantitativeDetails",
"min" : 0,
"max" : "1"
},
"contentReference" : "#ObservationDefinition.quantitativeDetails",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.component.qualifiedInterval",
"path" : "ObservationDefinition.component.qualifiedInterval",
"short" : "Qualified interval",
"definition" : "The qualified interval specified.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.component.qualifiedInterval",
"min" : 0,
"max" : "*"
},
"contentReference" : "#ObservationDefinition.qualifiedInterval",
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"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.url",
"path" : "ObservationDefinition.url",
"short" : "Logical canonical URL to reference this ObservationDefinition (globally unique)",
"definition" : "An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.",
"comment" : "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.",
"requirements" : "Allows the ObservationDefinition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.identifier",
"path" : "ObservationDefinition.identifier",
"short" : "Business identifier of the ObservationDefinition",
"definition" : "Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.",
"requirements" : "Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.version",
"path" : "ObservationDefinition.version",
"short" : "Business version of the ObservationDefinition",
"definition" : "The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.",
"comment" : "There may be multiple different instances of a ObservationDefinition that have the same identifier but different versions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.title",
"path" : "ObservationDefinition.title",
"short" : "Name for this ObservationDefinition (Human friendly)",
"definition" : "A short, descriptive, user-friendly title for the ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.derivedFromCanonical",
"path" : "ObservationDefinition.derivedFromCanonical",
"short" : "Based on FHIR definition of another observation",
"definition" : "The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.derivedFromUri",
"path" : "ObservationDefinition.derivedFromUri",
"short" : "Based on external definition",
"definition" : "The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.",
"requirements" : "Observation definitions may be refinements of other definitions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.status",
"path" : "ObservationDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The current state of the ObservationDefinition.",
"comment" : "A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation\nUnknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
}],
"strength" : "required",
"description" : "Codes identifying the state of an ObservationDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.2.0"
}
},
{
"id" : "ObservationDefinition.experimental",
"path" : "ObservationDefinition.experimental",
"short" : "If for testing purposes, not real usage",
"definition" : "A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of ObservationDefinition that are appropriate for use vs. not.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true
},
{
"id" : "ObservationDefinition.subject[x]",
"path" : "ObservationDefinition.subject[x]",
"short" : "Type of subject for the defined observation",
"definition" : "A code or group definition that describes the intended subject of Observation instances conforming to this ObservationDefinition.",
"comment" : "Examples: person, animal, device, air, surface ….",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.date",
"path" : "ObservationDefinition.date",
"short" : "Date status first applied",
"definition" : "For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.publisher",
"path" : "ObservationDefinition.publisher",
"short" : "The name of the individual or organization that published the ObservationDefinition",
"definition" : "Helps establish the \"authority/credibility\" of the ObservationDefinition. May also allow for contact.",
"requirements" : "Usually an organization, but may be an individual. The publisher (or steward) of the ObservationDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the ObservationDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the ObservationDefinition. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.contact",
"path" : "ObservationDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.description",
"path" : "ObservationDefinition.description",
"short" : "Natural language description of the ObservationDefinition",
"definition" : "A free text natural language description of the ObservationDefinition from the consumer's perspective.",
"comment" : "This description can be used to capture details such as why the ObservationDefinition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "ObservationDefinition.useContext",
"path" : "ObservationDefinition.useContext",
"short" : "Content intends to support these contexts",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of observation definitions.",
"comment" : "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}]
},
{
"id" : "ObservationDefinition.jurisdiction",
"path" : "ObservationDefinition.jurisdiction",
"short" : "Intended jurisdiction for this ObservationDefinition (if applicable)",
"definition" : "A jurisdiction in which the ObservationDefinition is intended to be used.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
}],
"strength" : "extensible",
"description" : "Codes for country, country subdivision and region for indicating where a resource is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
{
"id" : "ObservationDefinition.purpose",
"path" : "ObservationDefinition.purpose",
"short" : "Why this ObservationDefinition is defined",
"definition" : "Explains why this ObservationDefinition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the ObservationDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "ObservationDefinition.copyright",
"path" : "ObservationDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.",
"requirements" : "Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "ObservationDefinition.approvalDate",
"path" : "ObservationDefinition.approvalDate",
"short" : "When ObservationDefinition was approved by publisher",
"definition" : "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "ObservationDefinition.lastReviewDate",
"path" : "ObservationDefinition.lastReviewDate",
"short" : "Last review date for the ObservationDefinition",
"definition" : "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comment" : "If specified, this is usually after the approval date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "ObservationDefinition.effectivePeriod",
"path" : "ObservationDefinition.effectivePeriod",
"short" : "The effective date range for the ObservationDefinition",
"definition" : "The period during which the ObservationDefinition content was or is planned to be effective.",
"comment" : "The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation intended to be used for the year 2020 would be published in 2019.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.performerType",
"path" : "ObservationDefinition.performerType",
"short" : "Desired kind of performer for such kind of observation",
"definition" : "The type of individual/organization/device that is expected to act upon instances of this definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"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",
"definition" : "Describes what will be observed. Sometimes this is called the observation \"name\".",
"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.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.2.0"
},
"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.bodySite",
"path" : "ObservationDefinition.bodySite",
"short" : "Body part to be observed",
"definition" : "The site on the subject's body where the observation is to be made.",
"comment" : "Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. \nExample: 14975008 |Forearm structure|.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationBodySite"
}],
"strength" : "example",
"description" : "SNOMED CT body structures.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "rim",
"map" : "targetSiteCode"
}]
},
{
"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\nExample: 702659008 |Automated count technique|.",
"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.specimen",
"path" : "ObservationDefinition.specimen",
"short" : "Kind of specimen used by this type of observation",
"definition" : "The kind of specimen that this type of observation is produced on.",
"comment" : "Only used for in vitro observations.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "participation[typeCode=SPC].specimen"
}]
},
{
"id" : "ObservationDefinition.device",
"path" : "ObservationDefinition.device",
"short" : "Measurement device",
"definition" : "The measurement device used to produce observations of this type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"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.2.0"
},
"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.2.0"
},
"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"
}]
},
{
"id" : "ObservationDefinition.hasMember",
"path" : "ObservationDefinition.hasMember",
"short" : "Definitions of related resources belonging to this kind of observation group",
"definition" : "This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}]
},
{
"id" : "ObservationDefinition.component",
"path" : "ObservationDefinition.component",
"short" : "Component results",
"definition" : "Some observations have multiple component observations, expressed as separate code value pairs.",
"requirements" : "Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=COMP]"
}]
},
{
"id" : "ObservationDefinition.component.code",
"path" : "ObservationDefinition.component.code",
"short" : "Type of observation",
"definition" : "Describes what will be observed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"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" : "rim",
"map" : "code"
}]
},
{
"id" : "ObservationDefinition.component.permittedDataType",
"path" : "ObservationDefinition.component.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 of this component observations.",
"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.2.0"
}
},
{
"id" : "ObservationDefinition.component.quantitativeDetails",
"path" : "ObservationDefinition.component.quantitativeDetails",
"short" : "Quantitative details",
"definition" : "The quantitative details specified.",
"min" : 0,
"max" : "1",
"contentReference" : "#ObservationDefinition.quantitativeDetails"
},
{
"id" : "ObservationDefinition.component.qualifiedInterval",
"path" : "ObservationDefinition.component.qualifiedInterval",
"short" : "Qualified interval",
"definition" : "The qualified interval specified.",
"min" : 0,
"max" : "*",
"contentReference" : "#ObservationDefinition.qualifiedInterval"
}]
}
}
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.
FHIR ®© HL7.org 2011+. FHIR CI Build hl7.fhir.core#4.2.0 (GitHub f996518d66) generated on Tue, Dec 31, 2019 21:15+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change