Profile_R5_ObservationDefinition_R4B - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4B v0.1.0

Is Modifier false

Must Support false

Summary true

4. ObservationDefinition.meta

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.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. ObservationDefinition.implicitRules

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.

Short A set of rules under which this content was created

Comments

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.

Control 0..1

Is Modifier true because 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

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. ObservationDefinition.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

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).

Control 0..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)

IETF language tag

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. ObservationDefinition.text

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.

Short Text summary of the resource, for human interpretation

Comments

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.

Control 0..1

Narrative

Is Modifier false

Must Support false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. ObservationDefinition.contained

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.

Short Contained, inline Resources

Comments

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.

Control 0..*

Resource

Is Modifier false

Must Support false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

Invariants dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))

14. ObservationDefinition.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

This element introduces a set of slices on ObservationDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. ObservationDefinition.extension:url

Slice Name url

Definition

R5: ObservationDefinition.url (new:uri)

Short R5: Logical canonical URL to reference this ObservationDefinition (globally unique) (new)

Comments

Element ObservationDefinition.url has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.url has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.url: http://hl7.org/fhir/StructureDefinition/artifact-url. 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.

Control 0..1

Type Extension(Artifact URL) (Extension Type: uri)

Is Modifier false

Must Support false

Summary false

18. ObservationDefinition.extension:version

Slice Name version

Definition

R5: ObservationDefinition.version (new:string)

Short R5: Business version of the ObservationDefinition (new)

Comments

Element ObservationDefinition.version has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.version has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.version: http://hl7.org/fhir/StructureDefinition/artifact-version. There may be multiple different instances of an observationDefinition that have the same identifier but different versions.

Control 0..1

Type Extension(ArtifactVersion) (Extension Type: string)

Is Modifier false

Must Support false

Summary false

20. ObservationDefinition.extension:versionAlgorithm

Slice Name versionAlgorithm

Definition

R5: ObservationDefinition.versionAlgorithm[x] (new:Coding, string)

Short R5: How to compare versions (new)

Comments

Element ObservationDefinition.versionAlgorithm[x] has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.versionAlgorithm[x] has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Control 0..1

Type Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)

Is Modifier false

Must Support false

Summary false

22. ObservationDefinition.extension:name

Slice Name name

Definition

R5: ObservationDefinition.name (new:string)

Short R5: Name for this ObservationDefinition (computer friendly) (new)

Comments

Element ObservationDefinition.name has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.name has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.name: http://hl7.org/fhir/StructureDefinition/artifact-name. 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.

Control 0..1

Type Extension(ArtifactName) (Extension Type: string)

Is Modifier false

Must Support false

Summary false

24. ObservationDefinition.extension:title

Slice Name title

Definition

R5: ObservationDefinition.title (new:string)

Short R5: Name for this ObservationDefinition (human friendly) (new)

Comments

Element ObservationDefinition.title has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.title has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.title: http://hl7.org/fhir/StructureDefinition/artifact-title.

Control 0..1

Type Extension(Artifact Title) (Extension Type: string)

Is Modifier false

Must Support false

Summary false

26. ObservationDefinition.extension:experimental

Slice Name experimental

Definition

R5: ObservationDefinition.experimental (new:boolean)

Short R5: If for testing purposes, not real usage (new)

Comments

Element ObservationDefinition.experimental has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.experimental has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.experimental: http://hl7.org/fhir/StructureDefinition/artifact-experimental. Allows filtering of ObservationDefinition that are appropriate for use vs. not.

Control 0..1

Type Extension(Artifact Experimental) (Extension Type: boolean)

Is Modifier false

Must Support false

Summary false

28. ObservationDefinition.extension:date

Slice Name date

Definition

R5: ObservationDefinition.date (new:dateTime)

Short R5: Date last changed (new)

Comments

Element ObservationDefinition.date has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.date has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.date: http://hl7.org/fhir/StructureDefinition/artifact-date. 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.

Control 0..1

Type Extension(Artifact Date) (Extension Type: dateTime)

Is Modifier false

Must Support false

Summary false

30. ObservationDefinition.extension:publisher

Slice Name publisher

Definition

R5: ObservationDefinition.publisher (new:string)

Short R5: The name of the individual or organization that published the ObservationDefinition (new)

Comments

Element ObservationDefinition.publisher has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.publisher has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.publisher: http://hl7.org/fhir/StructureDefinition/artifact-publisher.

Control 0..1

Type Extension(Artifact Publisher) (Extension Type: string)

Is Modifier false

Must Support false

Summary false

32. ObservationDefinition.extension:contact

Slice Name contact

Definition

R5: ObservationDefinition.contact (new:ContactDetail)

Short R5: Contact details for the publisher (new)

Comments

Element ObservationDefinition.contact has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.contact has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.contact: http://hl7.org/fhir/StructureDefinition/artifact-contact. May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Control 0..*

Type Extension(Artifact Contact) (Extension Type: ContactDetail)

Is Modifier false

Must Support false

Summary false

34. ObservationDefinition.extension:description

Slice Name description

Definition

R5: ObservationDefinition.description (new:markdown)

Short R5: Natural language description of the ObservationDefinition (new)

Comments

Element ObservationDefinition.description has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.description has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.description: http://hl7.org/fhir/StructureDefinition/artifact-description. 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.

Control 0..1

Type Extension(Artifact Description) (Extension Type: markdown)

Is Modifier false

Must Support false

Summary false

36. ObservationDefinition.extension:useContext

Slice Name useContext

Definition

R5: ObservationDefinition.useContext (new:UsageContext)

Short R5: Content intends to support these contexts (new)

Comments

Element ObservationDefinition.useContext has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.useContext has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.useContext: http://hl7.org/fhir/StructureDefinition/artifact-useContext. When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

Control 0..*

Type Extension(Artifact use context) (Extension Type: UsageContext)

Is Modifier false

Must Support false

Summary false

38. ObservationDefinition.extension:jurisdiction

Slice Name jurisdiction

Definition

R5: ObservationDefinition.jurisdiction (new:CodeableConcept)

Short R5: Intended jurisdiction for this ObservationDefinition (if applicable) (new)

Comments

Element ObservationDefinition.jurisdiction has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.jurisdiction has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Element ObservationDefinition.jurisdiction has been flagged as deprecated. 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.)

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Intended jurisdiction for this ObservationDefinition (if applicable) (new)) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

40. ObservationDefinition.extension:purpose

Slice Name purpose

Definition

R5: ObservationDefinition.purpose (new:markdown)

Short R5: Why this ObservationDefinition is defined (new)

Comments

Element ObservationDefinition.purpose has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.purpose has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.purpose: http://hl7.org/fhir/StructureDefinition/artifact-purpose. 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.

Control 0..1

Type Extension(Artifact Purpose) (Extension Type: markdown)

Is Modifier false

Must Support false

Summary false

42. ObservationDefinition.extension:copyright

Slice Name copyright

Definition

R5: ObservationDefinition.copyright (new:markdown)

Short R5: Use and/or publishing restrictions (new)

Comments

Element ObservationDefinition.copyright has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.copyright has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.copyright: http://hl7.org/fhir/StructureDefinition/artifact-copyright.

Control 0..1

Type Extension(Artifact Copyright) (Extension Type: markdown)

Is Modifier false

Must Support false

Summary false

44. ObservationDefinition.extension:copyrightLabel

Slice Name copyrightLabel

Definition

R5: ObservationDefinition.copyrightLabel (new:string)

Short R5: Copyright holder and year(s) (new)

Comments

Element ObservationDefinition.copyrightLabel has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.copyrightLabel has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Control 0..1

Type Extension(Artifact Copyright Label) (Extension Type: string)

Is Modifier false

Must Support false

Summary false

46. ObservationDefinition.extension:approvalDate

Slice Name approvalDate

Definition

R5: ObservationDefinition.approvalDate (new:date)

Short R5: When ObservationDefinition was approved by publisher (new)

Comments

Element ObservationDefinition.approvalDate has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.approvalDate has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.approvalDate: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate. 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.

Control 0..1

Type Extension(Artifact Approval Date) (Extension Type: date)

Is Modifier false

Must Support false

Summary false

48. ObservationDefinition.extension:lastReviewDate

Slice Name lastReviewDate

Definition

R5: ObservationDefinition.lastReviewDate (new:date)

Short R5: Date on which the asset content was last reviewed by the publisher (new)

Comments

Element ObservationDefinition.lastReviewDate has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.lastReviewDate has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.lastReviewDate: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate. If specified, this is usually after the approval date.

See guidance around (not) making local changes to elements here.

Control 0..1

Type Extension(Artifact Last Review Date) (Extension Type: date)

Is Modifier false

Must Support false

Summary false

50. ObservationDefinition.extension:effectivePeriod

Slice Name effectivePeriod

Definition

R5: ObservationDefinition.effectivePeriod (new:Period)

Short R5: The effective date range for the ObservationDefinition (new)

Comments

Element ObservationDefinition.effectivePeriod has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.effectivePeriod has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.effectivePeriod: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod. 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.

Control 0..1

Type Extension(Artifact Effective Period) (Extension Type: Period)

Is Modifier false

Must Support false

Summary false

52. ObservationDefinition.extension:derivedFromCanonical

Slice Name derivedFromCanonical

Definition

R5: ObservationDefinition.derivedFromCanonical (new:canonical(ObservationDefinition))

Short R5: Based on FHIR definition of another observation (new)

Comments

Element ObservationDefinition.derivedFromCanonical has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.derivedFromCanonical has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Based on FHIR definition of another observation (new)) (Extension Type: canonical(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4B, ObservationDefinition))

Is Modifier false

Must Support false

Summary false

54. ObservationDefinition.extension:derivedFromUri

Slice Name derivedFromUri

Definition

R5: ObservationDefinition.derivedFromUri (new:uri)

Short R5: Based on external definition (new)

Comments

Element ObservationDefinition.derivedFromUri has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.derivedFromUri has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Based on external definition (new)) (Extension Type: uri)

Is Modifier false

Must Support false

Summary false

56. ObservationDefinition.extension:subject

Slice Name subject

Definition

R5: ObservationDefinition.subject (new:CodeableConcept)

Short R5: Type of subject for the defined observation (new)

Comments

Element ObservationDefinition.subject has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.subject has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Examples: person, animal, device, air, surface ….

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Type of subject for the defined observation (new)) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

58. ObservationDefinition.extension:performerType

Slice Name performerType

Definition

R5: ObservationDefinition.performerType (new:CodeableConcept)

Short R5: Desired kind of performer for such kind of observation (new)

Comments

Element ObservationDefinition.performerType has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.performerType has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Desired kind of performer for such kind of observation (new)) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

60. ObservationDefinition.extension:bodySite

Slice Name bodySite

Definition

R5: ObservationDefinition.bodySite (new:CodeableConcept)

Short R5: Body part to be observed (new)

Comments

Element ObservationDefinition.bodySite has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.bodySite has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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. Example: 14975008 |Forearm structure|.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Body part to be observed (new)) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

62. ObservationDefinition.extension:specimen

Slice Name specimen

Definition

R5: ObservationDefinition.specimen (new:Reference(SpecimenDefinition))

Short R5: Kind of specimen used by this type of observation (new)

Comments

Element ObservationDefinition.specimen has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.specimen has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Kind of specimen used by this type of observation (new)) (Extension Type: Reference(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4B, SpecimenDefinition))

Is Modifier false

Must Support false

Summary false

64. ObservationDefinition.extension:device

Slice Name device

Definition

R5: ObservationDefinition.device (new:Reference(DeviceDefinition,Device))

Short R5: Measurement device or model of device (new)

Comments

Element ObservationDefinition.device has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.device has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Measurement device or model of device (new)) (Extension Type: Reference(Cross-version Profile for R5.DeviceDefinition for use in FHIR R4B, DeviceDefinition, Cross-version Profile for R5.Device for use in FHIR R4B, Device))

Is Modifier false

Must Support false

Summary false

66. ObservationDefinition.extension:hasMember

Slice Name hasMember

Definition

R5: ObservationDefinition.hasMember (new:Reference(ObservationDefinition,Questionnaire))

Short R5: Definitions of related resources belonging to this kind of observation group (new)

Comments

Element ObservationDefinition.hasMember has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.hasMember has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Definitions of related resources belonging to this kind of observation group (new)) (Extension Type: Reference(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4B, ObservationDefinition, Cross-version Profile for R5.Questionnaire for use in FHIR R4B, Questionnaire))

Is Modifier false

Must Support false

Summary false

68. ObservationDefinition.extension:component

Slice Name component

Definition

R5: ObservationDefinition.component (new:BackboneElement)

Short R5: Component results (new)

Comments

Element ObservationDefinition.component has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.component has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Component results (new)) (Complex Extension)

Is Modifier false

Must Support false

70. ObservationDefinition.extension:qualifiedValue

Slice Name qualifiedValue

Definition

R5: ObservationDefinition.component.qualifiedValue (new:ObservationDefinition.qualifiedValue)

Short R5: Set of qualified values for observation results (new)

Comments

Element ObservationDefinition.component.qualifiedValue is part of an existing definition because parent element ObservationDefinition.component requires a cross-version extension. Element ObservationDefinition.component.qualifiedValue has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.component.qualifiedValue has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Set of qualified values for observation results) (Complex Extension)

Is Modifier false

Must Support false

72. ObservationDefinition.modifierExtension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Must Support false

Summary false

This element introduces a set of slices on ObservationDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

74. ObservationDefinition.modifierExtension:status

Slice Name status

Definition

R5: ObservationDefinition.status (new:code)

Short R5: draft | active | retired | unknown (new)

Comments

Element ObservationDefinition.status has a context of ObservationDefinition based on following the parent source element upwards and mapping to ObservationDefinition. Element ObservationDefinition.status has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ObservationDefinition.status: http://hl7.org/fhir/StructureDefinition/artifact-status. A nominal state-transition diagram can be found in the Definition pattern 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.

Control 1..1

Type Extension(Artifact Status) (Extension Type: code)

Is Modifier true because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration

Must Support false

Summary false

76. ObservationDefinition.category

Definition

A code that classifies the general type of observation.

Short Category of observation

Comments

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.

Control 0..*

For example codes, see ObservationCategoryCodes
(example to http://hl7.org/fhir/ValueSet/observation-category|4.3.0)

Codes for high level observation categories.

Is Modifier false

Must Support false

Summary true

Requirements

Used for filtering what kinds of observations are retrieved and displayed.

Alternate Names Class of observation

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

78. ObservationDefinition.code

Definition

Describes what will be observed. Sometimes this is called the observation "name".

Short Type of observation (code / type)

Control 1..1

For example codes, see LOINCCodes
(example to http://hl7.org/fhir/ValueSet/observation-codes|4.3.0)

Codes identifying names of simple observations.

Is Modifier false

Must Support false

Summary true

Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Alternate Names Name

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

80. ObservationDefinition.identifier

Definition

A unique identifier assigned to this ObservationDefinition artifact.

Short Business identifier for this ObservationDefinition instance

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

82. ObservationDefinition.permittedDataType

Definition

The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

Control 0..*

The codes SHALL be taken from ObservationDataType
(required to http://hl7.org/fhir/ValueSet/permitted-data-type|4.3.0)

Permitted data type for observation value.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Example General: CodeableConcept

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. ObservationDefinition.multipleResultsAllowed

Definition

Multiple results allowed for observations conforming to this ObservationDefinition.

Short Multiple results allowed

Comments

An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Example General: true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

86. ObservationDefinition.method

Definition

The method or technique used to perform the observation.

Short Method used to produce the observation

Comments

Only used if not implicit in observation code.

Control 0..1

For example codes, see ObservationMethods
(example to http://hl7.org/fhir/ValueSet/observation-methods|4.3.0)

Methods for simple observations.

Is Modifier false

Must Support false

Summary false

Requirements

In some cases, method can impact results.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

88. ObservationDefinition.preferredReportName

Definition

The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.

Short Preferred report name

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

90. ObservationDefinition.quantitativeDetails

Definition

Characteristics for quantitative results of this observation.

Short Characteristics of quantitative results

Control 0..1

BackboneElement

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

92. ObservationDefinition.quantitativeDetails.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

94. ObservationDefinition.quantitativeDetails.extension

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.

Short Additional content defined by implementations

Comments

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.

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

96. ObservationDefinition.quantitativeDetails.modifierExtension

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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

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.

Alternate Names extensions, user content, modifiers

98. ObservationDefinition.quantitativeDetails.customaryUnit

Definition

Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.

Short Customary unit for quantitative results

Control 0..1

Unless not suitable, these codes SHALL be taken from UCUMCodes
(extensible to http://hl7.org/fhir/ValueSet/ucum-units|4.3.0)

Codes identifying units of measure.

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

100. ObservationDefinition.quantitativeDetails.unit

Definition

SI unit used to report quantitative results of observations conforming to this ObservationDefinition.

Short SI unit for quantitative results

Control 0..1

Unless not suitable, these codes SHALL be taken from UCUMCodes
(extensible to http://hl7.org/fhir/ValueSet/ucum-units|4.3.0)

Codes identifying units of measure.

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

102. ObservationDefinition.quantitativeDetails.conversionFactor

Definition

Factor for converting value expressed with SI unit to value expressed with customary unit.

Short SI to Customary unit conversion factor

Control 0..1

decimal

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

104. ObservationDefinition.quantitativeDetails.decimalPrecision

Definition

Number of digits after decimal separator when the results of such observations are of type Quantity.

Short Decimal precision of observation quantitative results

Control 0..1

integer

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

106. ObservationDefinition.qualifiedInterval

Definition

Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.

Short Qualified range for continuous and ordinal observation results

Control 0..*

BackboneElement

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

108. ObservationDefinition.qualifiedInterval.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

110. ObservationDefinition.qualifiedInterval.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

112. ObservationDefinition.qualifiedInterval.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

114. ObservationDefinition.qualifiedInterval.category

Definition

The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.

Short reference | critical | absolute

Control 0..1

The codes SHALL be taken from ObservationRangeCategory
(required to http://hl7.org/fhir/ValueSet/observation-range-category|4.3.0)

Codes identifying the category of observation range.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Example General: critical

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

116. ObservationDefinition.qualifiedInterval.range

Definition

The low and high values determining the interval. There may be only one of the two.

Short The interval itself, for continuous or ordinal observations

Control 0..1

Range

Is Modifier false

Must Support false

Summary false

Requirements

The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

118. ObservationDefinition.qualifiedInterval.context

Definition

Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.

Short Range context qualifier

Control 0..1

Unless not suitable, these codes SHALL be taken from ObservationReferenceRangeMeaningCodes
(extensible to http://hl7.org/fhir/ValueSet/referencerange-meaning|4.3.0)

Code identifying the health context of a range.

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

120. ObservationDefinition.qualifiedInterval.appliesTo

Definition

Codes to indicate the target population this reference range applies to.

Short Targetted population of the range

Comments

If this element is not present then the global population is assumed.

Control 0..*

For example codes, see ObservationReferenceRangeAppliesToCodes
(example to http://hl7.org/fhir/ValueSet/referencerange-appliesto|4.3.0)

Codes identifying the population the reference range applies to.

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

122. ObservationDefinition.qualifiedInterval.gender

Definition

Sex of the population the range applies to.

Short male | female | other | unknown

Control 0..1

The codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0)

The gender of a person used for administrative purposes.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Example General: female

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

124. ObservationDefinition.qualifiedInterval.age

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.

Short Applicable age range, if relevant

Comments

Some analytes vary greatly over age.

Control 0..1

Range

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

126. ObservationDefinition.qualifiedInterval.gestationalAge

Definition

The gestational age to which this reference range is applicable, in the context of pregnancy.

Short Applicable gestational age range, if relevant

Control 0..1

Range

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

128. ObservationDefinition.qualifiedInterval.condition

Definition

Text based condition for which the reference range is valid.

Short Condition associated with the reference range

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

130. ObservationDefinition.validCodedValueSet

Definition

The set of valid coded results for the observations conforming to this ObservationDefinition.

Short Value set of valid coded values for the observations conforming to this ObservationDefinition

Control 0..1

Type Reference(ValueSet)

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

132. ObservationDefinition.validCodedValueSet.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

134. ObservationDefinition.validCodedValueSet.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ObservationDefinition.validCodedValueSet.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

136. ObservationDefinition.validCodedValueSet.extension:validCodedValueSet

Slice Name validCodedValueSet

Definition

R5: ObservationDefinition.qualifiedValue.validCodedValueSet additional types (canonical(http://hl7.org/fhir/StructureDefinition/ValueSet)) additional types from child elements (value)

Short R5: Value set of valid coded values as part of this set of qualified values additional types

Comments

Element ObservationDefinition.qualifiedValue.validCodedValueSet is mapped to FHIR R4B element ObservationDefinition.validCodedValueSet as SourceIsBroaderThanTarget. The mappings for ObservationDefinition.qualifiedValue.validCodedValueSet do not cover the following types: canonical. The mappings for ObservationDefinition.qualifiedValue.validCodedValueSet do not cover the following types based on type expansion: value.

Control 0..1

Type Extension(R5: Value set of valid coded values as part of this set of qualified values additional types) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

138. ObservationDefinition.validCodedValueSet.reference

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short Literal reference, Relative, internal or absolute URL

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 0..1
This element is affected by the following invariants: ref-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

140. ObservationDefinition.validCodedValueSet.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Short Type the reference refers to (e.g. "Patient")

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control 0..1

Binding Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

142. ObservationDefinition.validCodedValueSet.identifier

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Short Logical reference, when literal reference is not known

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

144. ObservationDefinition.validCodedValueSet.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

146. ObservationDefinition.normalCodedValueSet

Definition

The set of normal coded results for the observations conforming to this ObservationDefinition.

Short Value set of normal coded values for the observations conforming to this ObservationDefinition

Control 0..1

Type Reference(ValueSet)

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

148. ObservationDefinition.normalCodedValueSet.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

150. ObservationDefinition.normalCodedValueSet.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ObservationDefinition.normalCodedValueSet.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

152. ObservationDefinition.normalCodedValueSet.extension:normalCodedValueSet

Slice Name normalCodedValueSet

Definition

R5: ObservationDefinition.qualifiedValue.normalCodedValueSet additional types (canonical(http://hl7.org/fhir/StructureDefinition/ValueSet)) additional types from child elements (value)

Short R5: Value set of normal coded values as part of this set of qualified values additional types

Comments

Element ObservationDefinition.qualifiedValue.normalCodedValueSet is mapped to FHIR R4B element ObservationDefinition.normalCodedValueSet as SourceIsBroaderThanTarget. The mappings for ObservationDefinition.qualifiedValue.normalCodedValueSet do not cover the following types: canonical. The mappings for ObservationDefinition.qualifiedValue.normalCodedValueSet do not cover the following types based on type expansion: value.

Control 0..1

Type Extension(R5: Value set of normal coded values as part of this set of qualified values additional types) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

154. ObservationDefinition.normalCodedValueSet.reference

Definition

Short Literal reference, Relative, internal or absolute URL

Comments

Control 0..1
This element is affected by the following invariants: ref-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

156. ObservationDefinition.normalCodedValueSet.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Short Type the reference refers to (e.g. "Patient")

Comments

Control 0..1

Binding Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

158. ObservationDefinition.normalCodedValueSet.identifier

Definition

Short Logical reference, when literal reference is not known

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

160. ObservationDefinition.normalCodedValueSet.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

162. ObservationDefinition.abnormalCodedValueSet

Definition

The set of abnormal coded results for the observation conforming to this ObservationDefinition.

Short Value set of abnormal coded values for the observations conforming to this ObservationDefinition

Control 0..1

Type Reference(ValueSet)

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

164. ObservationDefinition.abnormalCodedValueSet.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

166. ObservationDefinition.abnormalCodedValueSet.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ObservationDefinition.abnormalCodedValueSet.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

168. ObservationDefinition.abnormalCodedValueSet.extension:abnormalCodedValueSet

Slice Name abnormalCodedValueSet

Definition

R5: ObservationDefinition.qualifiedValue.abnormalCodedValueSet additional types (canonical(http://hl7.org/fhir/StructureDefinition/ValueSet)) additional types from child elements (value)

Short R5: Value set of abnormal coded values as part of this set of qualified values additional types

Comments

Element ObservationDefinition.qualifiedValue.abnormalCodedValueSet is mapped to FHIR R4B element ObservationDefinition.abnormalCodedValueSet as SourceIsBroaderThanTarget. The mappings for ObservationDefinition.qualifiedValue.abnormalCodedValueSet do not cover the following types: canonical. The mappings for ObservationDefinition.qualifiedValue.abnormalCodedValueSet do not cover the following types based on type expansion: value.

Control 0..1

Type Extension(R5: Value set of abnormal coded values as part of this set of qualified values additional types) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

170. ObservationDefinition.abnormalCodedValueSet.reference

Definition

Short Literal reference, Relative, internal or absolute URL

Comments

Control 0..1
This element is affected by the following invariants: ref-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

172. ObservationDefinition.abnormalCodedValueSet.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Short Type the reference refers to (e.g. "Patient")

Comments

Control 0..1

Binding Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

174. ObservationDefinition.abnormalCodedValueSet.identifier

Definition

Short Logical reference, when literal reference is not known

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

176. ObservationDefinition.abnormalCodedValueSet.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

178. ObservationDefinition.criticalCodedValueSet

Definition

The set of critical coded results for the observation conforming to this ObservationDefinition.

Short Value set of critical coded values for the observations conforming to this ObservationDefinition

Control 0..1

Type Reference(ValueSet)

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

180. ObservationDefinition.criticalCodedValueSet.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

182. ObservationDefinition.criticalCodedValueSet.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ObservationDefinition.criticalCodedValueSet.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

184. ObservationDefinition.criticalCodedValueSet.extension:criticalCodedValueSet

Slice Name criticalCodedValueSet

Definition

R5: ObservationDefinition.qualifiedValue.criticalCodedValueSet additional types (canonical(http://hl7.org/fhir/StructureDefinition/ValueSet)) additional types from child elements (value)

Short R5: Value set of critical coded values as part of this set of qualified values additional types

Comments

Element ObservationDefinition.qualifiedValue.criticalCodedValueSet is mapped to FHIR R4B element ObservationDefinition.criticalCodedValueSet as SourceIsBroaderThanTarget. The mappings for ObservationDefinition.qualifiedValue.criticalCodedValueSet do not cover the following types: canonical. The mappings for ObservationDefinition.qualifiedValue.criticalCodedValueSet do not cover the following types based on type expansion: value.

Control 0..1

Type Extension(R5: Value set of critical coded values as part of this set of qualified values additional types) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

186. ObservationDefinition.criticalCodedValueSet.reference

Definition

Short Literal reference, Relative, internal or absolute URL

Comments

Control 0..1
This element is affected by the following invariants: ref-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

188. ObservationDefinition.criticalCodedValueSet.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Short Type the reference refers to (e.g. "Patient")

Comments

Control 0..1

Binding Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

190. ObservationDefinition.criticalCodedValueSet.identifier

Definition

Short Logical reference, when literal reference is not known

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

192. ObservationDefinition.criticalCodedValueSet.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1