--- type: "resource" title: "ObservationDefinition" resource: "ObservationDefinition" --- # ObservationDefinition ## Introduction > **Note to Balloters:** To ensure the ObservationDefinition resource is ready for Normative status, we are seeking ballot comments on the substantive content. The key changes made since R5 include: > > - Updated ObservationDefinition.bodySite (CodeableConcept) to ObservationDefinition.bodyStructure (CodeableReference). > - Updated ObservationDefinition.device for the canonical DeviceDefinition. > - Added ObservationDefinition.qualifiedValue.interpretation. > - Jurisdiction has been reinstated (it was marked "Deprecated" in R5). ## Scope and Usage An instance of ObservationDefinition represents the definitional aspects of a kind of observation. This resource is used in a catalog of products or services for healthcare. It represents a set of constraints applicable to the value produced by observations of this kind. It helps the consumer of the results of observations of that kind, to interpret properly these results. If one wants to technically constrain an Observation resource for a particular use case across implementers, a profile is the preferred option and may include profiling on ObservationDefinition and Observation. For instance, in a catalog of laboratory in vitro diagnostic services, the ObservationDefinition resources describe the observations that should be provided by the orderer alongside with an ordered service (questions asked at order entry or at specimen collection, prior results) as well as the observations that will be reported once the service has been performed. Observation Definition resources can be used to describe observations which may need to be evaluated in order to determine whether a specific medicine can be administered or held (e.g., weight, lab value result) and provide guidance on the dose to be administered (e.g., sliding scale insulin dose). In the catalog of tests of an in vitro diagnostic device, ObservationDefinition resources can be used to characterize (absolute range, unit, decimal precision, critical values ...) the observations that will be produced by the IVD tests performed by the device. ObservationDefinition may be used to characterize observations from any discipline. ## Boundaries and Relationships An ObservationDefinition resource provides the definitional characteristics for a certain kind of observation. Each time that kind of observation is collected and recorded it is instantiated as an Observation resource, which conforms to these definitional characteristics. Thus, there is a relationship between ObservationDefinition and Observation: The latter may instantiate the former. When an Observation instantiates an ObservationDefinition, the elements of the Observation resource are expected to inherit their content from the corresponding definitional elements declared in the ObservationDefinition resource: - Category, code, datatype of the value, bodyStructure, method. - Each referenceRange element present in Observation should come from a qualifiedValue element of ObservationDefinition. - If ObservationDefinition has declared a ValueSet of valid coded values, and if Observation has a valueCodeableConcept, the value is expected to be part of that ValueSet. - The subject of the Observation should be conformant with one of the codeable concepts in subject listed in ObservationDefinition. - If the Observation has a device element, the referenced Device resource should conform to a DeviceDefinition or Device referenced by ObservationDefinition.device (if present). - If the Observation has a specimen element, the referenced Specimen resource should conform to a SpecimenDefinition referenced by ObservationDefinition.specimen (if present). ObservationDefinition can specify units allowed for the valueQuantity element by setting ObservationDefinition.permittedUnit. ObservationDefinitions are only to be used when describing the contents of an observation (including observations in order catalogs or panels). When additional structure, sequence, or rules are needed, the Questionnaire resource should be used. ## Background and Context Provides additional detail on exactly how the resource is to be used ## StructureDefinition ### Elements (Simplified) - **[ObservationDefinition](/observationdefinition-definitions#ObservationDefinition)** [0..*]: - Definition of an observation - **[ObservationDefinition.url](/observationdefinition-definitions#ObservationDefinition.url)** [0..1]: [uri](/uri) Logical canonical URL to reference this ObservationDefinition (globally unique) - **[ObservationDefinition.identifier](/observationdefinition-definitions#ObservationDefinition.identifier)** [0..1]: [Identifier](/Identifier) Business identifier of the ObservationDefinition - **[ObservationDefinition.version](/observationdefinition-definitions#ObservationDefinition.version)** [0..1]: [string](/string) Business version of the ObservationDefinition - **[ObservationDefinition.versionAlgorithm[x]](/observationdefinition-definitions#ObservationDefinition.versionAlgorithm%5Bx%5D)** [0..1]: [string](/string), [Coding](/Coding) extensible:[version-algorithm](/valueset-version-algorithm) How to compare versions - **[ObservationDefinition.name](/observationdefinition-definitions#ObservationDefinition.name)** [0..1]: [string](/string) Name for this ObservationDefinition (computer friendly) - **[ObservationDefinition.title](/observationdefinition-definitions#ObservationDefinition.title)** [0..1]: [string](/string) Name for this ObservationDefinition (human friendly) - **[ObservationDefinition.status](/observationdefinition-definitions#ObservationDefinition.status)** [1..1]: [code](/code) required:[publication-status](/valueset-publication-status) draft | active | retired | unknown - **[ObservationDefinition.experimental](/observationdefinition-definitions#ObservationDefinition.experimental)** [0..1]: [boolean](/boolean) If For testing only - never for real usage - **[ObservationDefinition.date](/observationdefinition-definitions#ObservationDefinition.date)** [0..1]: [dateTime](/dateTime) Date last changed - **[ObservationDefinition.publisher](/observationdefinition-definitions#ObservationDefinition.publisher)** [0..1]: [string](/string) The name of the individual or organization that published the ObservationDefinition - **[ObservationDefinition.contact](/observationdefinition-definitions#ObservationDefinition.contact)** [0..*]: [ContactDetail](/ContactDetail) Contact details for the publisher - **[ObservationDefinition.description](/observationdefinition-definitions#ObservationDefinition.description)** [0..1]: [markdown](/markdown) Natural language description of the ObservationDefinition - **[ObservationDefinition.useContext](/observationdefinition-definitions#ObservationDefinition.useContext)** [0..*]: [UsageContext](/UsageContext) Content intends to support these contexts - **[ObservationDefinition.jurisdiction](/observationdefinition-definitions#ObservationDefinition.jurisdiction)** [0..*]: [CodeableConcept](/CodeableConcept) extensible:[jurisdiction](/valueset-jurisdiction) Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable) - **[ObservationDefinition.purpose](/observationdefinition-definitions#ObservationDefinition.purpose)** [0..1]: [markdown](/markdown) Why this ObservationDefinition is defined - **[ObservationDefinition.copyright](/observationdefinition-definitions#ObservationDefinition.copyright)** [0..1]: [markdown](/markdown) Notice about intellectual property ownership, can include restrictions on use - **[ObservationDefinition.copyrightLabel](/observationdefinition-definitions#ObservationDefinition.copyrightLabel)** [0..1]: [string](/string) Copyright holder and year(s) - **[ObservationDefinition.approvalDate](/observationdefinition-definitions#ObservationDefinition.approvalDate)** [0..1]: [date](/date) When ObservationDefinition was approved by publisher - **[ObservationDefinition.lastReviewDate](/observationdefinition-definitions#ObservationDefinition.lastReviewDate)** [0..1]: [date](/date) Date on which the asset content was last reviewed by the publisher - **[ObservationDefinition.effectivePeriod](/observationdefinition-definitions#ObservationDefinition.effectivePeriod)** [0..1]: [Period](/Period) The effective date range for the ObservationDefinition - **[ObservationDefinition.derivedFromCanonical](/observationdefinition-definitions#ObservationDefinition.derivedFromCanonical)** [0..*]: [canonical](/canonical) Based on FHIR definition of another observation - **[ObservationDefinition.derivedFromUri](/observationdefinition-definitions#ObservationDefinition.derivedFromUri)** [0..*]: [uri](/uri) Based on external definition - **[ObservationDefinition.subject](/observationdefinition-definitions#ObservationDefinition.subject)** [0..*]: [CodeableConcept](/CodeableConcept) Type of subject for the defined observation - **[ObservationDefinition.performerType](/observationdefinition-definitions#ObservationDefinition.performerType)** [0..1]: [CodeableConcept](/CodeableConcept) Desired kind of performer for such kind of observation - **[ObservationDefinition.category](/observationdefinition-definitions#ObservationDefinition.category)** [0..*]: [CodeableConcept](/CodeableConcept) example:[observation-category](/valueset-observation-category) General type of observation - **[ObservationDefinition.code](/observationdefinition-definitions#ObservationDefinition.code)** [1..1]: [CodeableConcept](/CodeableConcept) example:[observation-codes-observationorboth](/valueset-observation-codes-observationorboth) Type of observation - **[ObservationDefinition.permittedDataType](/observationdefinition-definitions#ObservationDefinition.permittedDataType)** [0..*]: [code](/code) required:[permitted-data-type](/valueset-permitted-data-type) Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period - **[ObservationDefinition.multipleResultsAllowed](/observationdefinition-definitions#ObservationDefinition.multipleResultsAllowed)** [0..1]: [boolean](/boolean) Multiple results allowed for conforming observations - **[ObservationDefinition.bodyStructure](/observationdefinition-definitions#ObservationDefinition.bodyStructure)** [0..1]: [CodeableReference](/CodeableReference) example:[body-site](/valueset-body-site) Body structure to be observed - **[ObservationDefinition.method](/observationdefinition-definitions#ObservationDefinition.method)** [0..1]: [CodeableConcept](/CodeableConcept) example:[observation-methods](/valueset-observation-methods) Method used to produce the observation - **[ObservationDefinition.specimen](/observationdefinition-definitions#ObservationDefinition.specimen)** [0..*]: Reference([SpecimenDefinition](/SpecimenDefinition)) Kind of specimen used by this type of observation - **[ObservationDefinition.device[x]](/observationdefinition-definitions#ObservationDefinition.device%5Bx%5D)** [0..1]: Reference([Device](/Device)), [canonical](/canonical) Measurement device or model of device - **[ObservationDefinition.preferredReportName](/observationdefinition-definitions#ObservationDefinition.preferredReportName)** [0..1]: [string](/string) The preferred name to be used when reporting the observation results - **[ObservationDefinition.permittedUnit](/observationdefinition-definitions#ObservationDefinition.permittedUnit)** [0..*]: [Coding](/Coding) preferred:[ucum-units](/valueset-ucum-units) Unit for quantitative results - **[ObservationDefinition.qualifiedValue](/observationdefinition-definitions#ObservationDefinition.qualifiedValue)** [0..*]: [BackboneElement](/BackboneElement) Set of qualified values for observation results - **[ObservationDefinition.qualifiedValue.context](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.context)** [0..1]: [CodeableConcept](/CodeableConcept) extensible:[referencerange-meaning](/valueset-referencerange-meaning) Context qualifier for the set of qualified values - **[ObservationDefinition.qualifiedValue.appliesTo](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.appliesTo)** [0..*]: [CodeableConcept](/CodeableConcept) example:[referencerange-appliesto](/valueset-referencerange-appliesto) Targetted population for the set of qualified values - **[ObservationDefinition.qualifiedValue.sexParameterForClinicalUse](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.sexParameterForClinicalUse)** [0..1]: [code](/code) required:[administrative-gender](/valueset-administrative-gender) male | female | other | unknown - **[ObservationDefinition.qualifiedValue.age](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.age)** [0..1]: [Range](/Range) Applicable age range for the set of qualified values - **[ObservationDefinition.qualifiedValue.gestationalAge](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.gestationalAge)** [0..1]: [Range](/Range) Applicable gestational age range for the set of qualified values - **[ObservationDefinition.qualifiedValue.condition](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.condition)** [0..1]: [string](/string) Validity criterion for the qualified value - **[ObservationDefinition.qualifiedValue.rangeCategory](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.rangeCategory)** [0..1]: [code](/code) required:[observation-range-category](/valueset-observation-range-category) reference | critical | absolute - **[ObservationDefinition.qualifiedValue.range](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.range)** [0..1]: [Range](/Range) The range for continuous or ordinal observations - **[ObservationDefinition.qualifiedValue.validCodedValueSet](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.validCodedValueSet)** [0..1]: [canonical](/canonical) Value set of valid coded values as part of this set of qualified values - **[ObservationDefinition.qualifiedValue.normalCodedValueSet](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.normalCodedValueSet)** [0..1]: [canonical](/canonical) Value set of normal coded values as part of this set of qualified values - **[ObservationDefinition.qualifiedValue.abnormalCodedValueSet](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.abnormalCodedValueSet)** [0..1]: [canonical](/canonical) Value set of abnormal coded values as part of this set of qualified values - **[ObservationDefinition.qualifiedValue.criticalCodedValueSet](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.criticalCodedValueSet)** [0..1]: [canonical](/canonical) Value set of critical coded values as part of this set of qualified values - **[ObservationDefinition.qualifiedValue.interpretation](/observationdefinition-definitions#ObservationDefinition.qualifiedValue.interpretation)** [0..*]: [CodeableConcept](/CodeableConcept) extensible:[observation-interpretation](/valueset-observation-interpretation) Expected coded interpretation values - **[ObservationDefinition.hasMember](/observationdefinition-definitions#ObservationDefinition.hasMember)** [0..*]: [Reference(ObservationDefinition](/Reference(ObservationDefinition), [Questionnaire)](/Questionnaire)) Definitions of related resources belonging to this kind of observation group - **[ObservationDefinition.component](/observationdefinition-definitions#ObservationDefinition.component)** [0..*]: [BackboneElement](/BackboneElement) Component results - **[ObservationDefinition.component.code](/observationdefinition-definitions#ObservationDefinition.component.code)** [1..1]: [CodeableConcept](/CodeableConcept) example:[observation-codes-observationorboth](/valueset-observation-codes-observationorboth) Type of observation - **[ObservationDefinition.component.permittedDataType](/observationdefinition-definitions#ObservationDefinition.component.permittedDataType)** [0..*]: [code](/code) required:[permitted-data-type](/valueset-permitted-data-type) Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period - **[ObservationDefinition.component.permittedUnit](/observationdefinition-definitions#ObservationDefinition.component.permittedUnit)** [0..*]: [Coding](/Coding) preferred:[ucum-units](/valueset-ucum-units) Unit for quantitative results - **[ObservationDefinition.component.qualifiedValue](/observationdefinition-definitions#ObservationDefinition.component.qualifiedValue)** [0..*]: - Set of qualified values for observation results ## Mappings - [ObservationDefinition Mappings](/observationdefinition-mappings) — 44 mapping entries ## Resource Packs ### list-ObservationDefinition-packs.xml ```xml ``` ## Search Parameters - [category](/observationdefinition-search#category) — **token** — Category (class) of observation — `ObservationDefinition.category` - [code](/observationdefinition-search#code) — **token** — Observation code — `ObservationDefinition.code` - [experimental](/observationdefinition-search#experimental) — **token** — Not for genuine usage (true) — `ObservationDefinition.experimental` - [identifier](/observationdefinition-search#identifier) — **token** — The unique identifier associated with the specimen definition — `ObservationDefinition.identifier` - [method](/observationdefinition-search#method) — **token** — Method of observation — `ObservationDefinition.method` - [status](/observationdefinition-search#status) — **token** — Publication status of the ObservationDefinition: draft, active, retired, unknown — `ObservationDefinition.status` - [title](/observationdefinition-search#title) — **string** — Human-friendly name of the ObservationDefinition — `ObservationDefinition.title` - [url](/observationdefinition-search#url) — **uri** — The uri that identifies the observation definition — `ObservationDefinition.url` - [reference](/observationdefinition-search#reference) — **reference** — Body structure to be observed (reference) — `ObservationDefinition.bodyStructure.reference` - [body-structure-code](/observationdefinition-search#body-structure-code) — **token** — Code for body structure to be observed — `ObservationDefinition.bodyStructure.concept` [Full Search Parameters](/observationdefinition-search) ## Examples - [example-ck-panel](/observationdefinition-example-example-ck-panel) — observationdefinition-example-ck-panel — Example of observationdefinition for Creatine Kinase panel with multiple components - [observationdefinition-example-ck-panel](/observationdefinition-example-observationdefinition-example-ck-panel) — observationdefinition-example-ck-panel - [observationdefinition-examples-header](/observationdefinition-example-observationdefinition-examples-header) — observationdefinition-examples-header [Full Examples](/observationdefinition-examples) ## Mapping Exceptions ### observationdefinition-definition-mapping-exceptions.xml ### Divergent Elements - **Definition.url** → **ObservationDefinition.url** - shortUnmatched | reason=Unknown | pattern=Canonical identifier for this observation definition, represented as an absolute URI (globally unique) | resource=Logical canonical URL to reference this ObservationDefinition (globally unique) - definitionUnmatched | reason=Unknown | pattern=An absolute URI that is used to identify this observation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this observation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the observation definition is stored on different servers. | resource=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. - commentsUnmatched | reason=Unknown | pattern=Can be a `urn:uuid:` or a `urn:oid:` but real `http/s:` addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found. | resource=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. - requirementsUnmatched | reason=Unknown | pattern=Allows the observation definition to be referenced by a single globally unique identifier. | resource=Allows the ObservationDefinition to be referenced by a single globally unique identifier. - **Definition.identifier** → **ObservationDefinition.identifier** - shortUnmatched | reason=Unknown | pattern=Business identifier for observation definition | resource=Business identifier of the ObservationDefinition - definitionUnmatched | reason=Unknown | pattern=A formal identifier that is used to identify this observation definition when it is represented in other formats, or referenced in a specification, model, design or an instance. | resource=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. - commentsUnmatched | reason=Unknown | pattern=Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this observation definition outside of FHIR, where it is not possible to use the logical URI. | resource=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. - requirementsUnmatched | reason=Unknown | pattern=Allows externally provided and/or usable business identifiers to be easily associated with the observation definition. | resource=Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers. - **Definition.version** → **ObservationDefinition.version** - shortUnmatched | reason=Unknown | pattern=Business version of the observation definition | resource=Business version of the ObservationDefinition - definitionUnmatched | reason=Unknown | pattern=The identifier that is used to identify this version of the observation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the observation definition 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 can be placed in a lexicographical sequence. | resource=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. - commentsUnmatched | reason=Unknown | pattern=There may be different observation definitions that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the observation definition with the format. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format). | resource=There may be multiple different instances of an observationDefinition that have the same identifier but different versions. - **Definition.name** → **ObservationDefinition.name** - shortUnmatched | reason=Unknown | pattern=Name for this observation definition (computer friendly) | resource=Name for this ObservationDefinition (computer friendly) - definitionUnmatched | reason=Unknown | pattern=A natural language name identifying the observation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. | resource=A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. - commentsUnmatched | reason=Unknown | pattern=The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly. | resource=The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. - requirementsUnmatched | reason=Unknown | pattern=Supports code generation. | resource=Support human navigation and code generation. - **Definition.title** → **ObservationDefinition.title** - shortUnmatched | reason=Unknown | pattern=Name for this observation definition (human friendly) | resource=Name for this ObservationDefinition (human friendly) - definitionUnmatched | reason=Unknown | pattern=A short, descriptive, user-friendly title for the observation definition. | resource=A short, descriptive, user-friendly title for the ObservationDefinition. - commentsUnmatched | reason=Unknown | pattern=This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. - **Definition.derivedFromCanonical** → **ObservationDefinition.derivedFromCanonical** - missingTypes | reason=Unknown | pattern=canonical(Definition) - extraTypes | reason=Unknown - shortUnmatched | reason=Unknown | pattern=Based on FHIR protocol or definition | resource=Based on FHIR definition of another observation - definitionUnmatched | reason=Unknown | pattern=The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition. | resource=The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition. - requirementsUnmatched | reason=Unknown | pattern=Protocols and order sets may be refinements of more generic protocols and order sets. - **Definition.derivedFromUri** → **ObservationDefinition.derivedFromUri** - shortUnmatched | reason=Unknown | pattern=Based on external protocol or definition | resource=Based on external definition - definitionUnmatched | reason=Unknown | pattern=The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition. | resource=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. - commentsUnmatched | reason=Unknown | pattern=This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. - requirementsUnmatched | reason=Unknown | pattern=Protocols and order sets may be refinements of more generic protocols and order sets. | resource=Observation definitions may be refinements of other definitions. - **Definition.status** → **ObservationDefinition.status** - definitionUnmatched | reason=Unknown | pattern=The current state of this observation definition. | resource=The current state of the ObservationDefinition. - commentsUnmatched | reason=Unknown | pattern=A nominal state-transition diagram can be found in the] documentation Unknown 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. | resource=A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation Unknown 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. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). - requirementsUnmatched | reason=Unknown | pattern=Enables tracking the lifecycle of the content and filtering of observation definitions that are appropriate for use versus not. - **Definition.experimental** → **ObservationDefinition.experimental** - definitionUnmatched | reason=Unknown | pattern=A Boolean value to indicate that this observation definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage. | resource=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. - commentsUnmatched | reason=Unknown | pattern=Allows filtering of observation definitions that are appropriate for use versus not. | resource=Allows filtering of ObservationDefinition that are appropriate for use vs. not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc - requirementsUnmatched | reason=Unknown | pattern=Enables experimental content to be developed following the same lifecycle that would be used for a production-level observation definition. - **Definition.subject** → **ObservationDefinition.subject** - missingTypes | reason=Unknown | pattern=CodeableReference(Group) - extraTypes | reason=Unknown - shortUnmatched | reason=Unknown | pattern=Type of individual the defined service is for | resource=Type of subject for the defined observation - definitionUnmatched | reason=Unknown | pattern=A code or group definition that describes the intended subject of instantiations of this definition. | resource=A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition. - requirementsUnmatched | reason=Unknown | pattern=Many protocols, order sets and guidelines are intended for use only with specific types of patients or subjects. - **Definition.date** → **ObservationDefinition.date** - definitionUnmatched | reason=Unknown | pattern=The date (and optionally time) when the observation definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the observation definition changes. | resource=The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes. - commentsUnmatched | reason=Unknown | pattern=The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the observation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | resource=The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). - **Definition.publisher** → **ObservationDefinition.publisher** - shortUnmatched | reason=Unknown | pattern=Name of the publisher/steward (organization or individual) | resource=The name of the individual or organization that published the ObservationDefinition - definitionUnmatched | reason=Unknown | pattern=The name of the organization or individual responsible for the release and ongoing maintenance of the observation definition. | resource=Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact. - commentsUnmatched | reason=Unknown | pattern=Usually an organization but may be an individual. The publisher (or steward) of the observation definition is the organization or individual primarily responsible for the maintenance and upkeep of the observation definition. 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 observation definition. This item SHOULD be populated unless the information is available from context. - requirementsUnmatched | reason=Unknown | pattern=Helps establish the "authority/credibility" of the observation definition. May also allow for contact. | resource=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. - **Definition.description** → **ObservationDefinition.description** - summary | reason=Unknown | pattern=true - shortUnmatched | reason=Unknown | pattern=Natural language description of the observation definition | resource=Natural language description of the ObservationDefinition - definitionUnmatched | reason=Unknown | pattern=A free text natural language description of the observation definition from a consumer's perspective. | resource=A free text natural language description of the ObservationDefinition from the consumer's perspective. - commentsUnmatched | reason=Unknown | pattern=This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the observation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context. | resource=This description can be used to capture details such as 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. - **Definition.useContext** → **ObservationDefinition.useContext** - shortUnmatched | reason=Unknown | pattern=The context that the content is intended to support | resource=Content intends to support these contexts - definitionUnmatched | reason=Unknown | pattern=The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate observation definitions. | resource=The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances. - commentsUnmatched | reason=Unknown | pattern=When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply. | resource=When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. - **Definition.jurisdiction** → **ObservationDefinition.jurisdiction** - shortUnmatched | reason=Unknown | pattern=Intended jurisdiction for observation definition (if applicable) | resource=Jurisdiction of the authority that maintains the this ObservationDefinition (if applicable) - definitionUnmatched | reason=Unknown | pattern=A legal or geographic region in which the observation definition is intended to be used. | resource=A jurisdiction in which the ObservationDefinition is intended to be used. - commentsUnmatched | reason=Unknown | pattern=It may be possible for the observation definition to be used in jurisdictions other than those for which it was originally designed or intended DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.). | resource=It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) - **Definition.purpose** → **ObservationDefinition.purpose** - shortUnmatched | reason=Unknown | pattern=Why this observation definition is defined | resource=Why this ObservationDefinition is defined - definitionUnmatched | reason=Unknown | pattern=Explanation of why this observation definition is needed and why it has been designed as it has. | resource=Explains why this ObservationDefinition is needed and why it has been designed as it has. - commentsUnmatched | reason=Unknown | pattern=This element does not describe the usage of the observation definition. Instead, it provides 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 observation definition. | resource=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. - **Definition.copyright** → **ObservationDefinition.copyright** - definitionUnmatched | reason=Unknown | pattern=A copyright statement relating to the observation definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the observation definition. | resource=Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the ObservationDefinition. - requirementsUnmatched | reason=Unknown | pattern=Consumers of the observation definition must be able to determine any legal restrictions on the use of the artifact and/or its content. | resource=Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content. - **Definition.approvalDate** → **ObservationDefinition.approvalDate** - shortUnmatched | reason=Unknown | pattern=When the observation definition was approved by publisher | resource=When ObservationDefinition was approved by publisher - definitionUnmatched | reason=Unknown | pattern=The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | resource=The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. - commentsUnmatched | reason=Unknown | pattern=The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | resource=The date may be more recent than the approval date because of minor changes / editorial corrections. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). - **Definition.lastReviewDate** → **ObservationDefinition.lastReviewDate** - shortUnmatched | reason=Unknown | pattern=When the observation definition was last reviewed | resource=Date on which the asset content was last reviewed by the publisher - definitionUnmatched | reason=Unknown | pattern=The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | resource=The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. - commentsUnmatched | reason=Unknown | pattern=If specified, this date follows the original approval date. | resource=If specified, this is usually after the approval date. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). - requirementsUnmatched | reason=Unknown | pattern=Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. - **Definition.effectivePeriod** → **ObservationDefinition.effectivePeriod** - shortUnmatched | reason=Unknown | pattern=When the observation definition is expected to be used | resource=The effective date range for the ObservationDefinition - definitionUnmatched | reason=Unknown | pattern=The period during which the observation definition content was or is planned to be in active use. | resource=The period during which the ObservationDefinition content was or is planned to be effective. - commentsUnmatched | reason=Unknown | pattern=The effective period for a observation definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. | resource=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 definition intended to be used for the year 2021 might be published in 2020. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). - requirementsUnmatched | reason=Unknown | pattern=Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the observation definition are or are expected to be used instead. - **Definition.performerType** → **ObservationDefinition.performerType** - shortUnmatched | reason=Unknown | pattern=Desired kind of service performer | resource=Desired kind of performer for such kind of observation - definitionUnmatched | reason=Unknown | pattern=The type of individual that is expected to act upon instances of this definition. | resource=The type of individual/organization/device that is expected to act upon instances of this definition. - **Definition.code** → **ObservationDefinition.code** - shortUnmatched | reason=Unknown | pattern=Service to be done | resource=Type of observation - definitionUnmatched | reason=Unknown | pattern=A code that identifies the specific service or action that was or is being performed. | resource=Describes what will be observed. Sometimes this is called the observation "name". ### Unmapped Elements - **Definition.copyrightLabel** — Unknown - **Definition.product** — Unknown - **Definition.partOf** — Unknown - **Definition.topic** — Unknown ### observationdefinition-fivews-mapping-exceptions.xml ### Unmapped Elements - **FiveWs.recorded** — Unknown - **FiveWs.author** — Unknown - **FiveWs.actor** — Unknown - **FiveWs.cause** — Unknown - **FiveWs.version** — Unknown - **FiveWs.witness** — Unknown - **FiveWs.where** — Unknown - **FiveWs.context** — Unknown - **FiveWs.init** — Unknown - **FiveWs.why** — Unknown - **FiveWs.identifier** — Unknown - **FiveWs.source** — Unknown - **FiveWs.who** — Unknown - **FiveWs.grade** — Unknown - **FiveWs.status** — Unknown - **FiveWs.planned** — Unknown - **FiveWs.done** — Unknown - **FiveWs.subject** — Unknown