GP Connect - Update Record (ITK3)

Part of the GP Connect product family

Profile: CareConnect-GPC-Observation-1

versionIdΣ0..1id
lastUpdatedΣ0..1instant
profileΣ1..*uri
securityΣ0..*CodingBinding
tagΣ0..*Coding
reasonS I0..*Extension(Reference(CareConnect-Condition-1), CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(CareConnect-GPC-Organization-1)
basedOnΣ I0..*Reference(CareConnect-CarePlan-1 | DeviceRequest | ImmunizationRecommendation | NutritionOrder | CareConnect-GPC-ProcedureRequest-1 | CareConnect-GPC-ReferralRequest-1 | CareConnect-GPC-MedicationRequest-1)
statusΣ ?!1..1codeBinding
snomedCTDescriptionIDI0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
snomedCTDescriptionIDI0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
subjectS Σ I1..1Reference(CareConnect-GPC-Patient-1)
contextS I0..1Reference(CareConnect-GPC-Encounter-1)
effectiveDateTimedateTime
effectivePeriodPeriod
issuedS Σ1..1instant
performerS Σ I0..*Reference(CareConnect-RelatedPerson-1 | CareConnect-GPC-Patient-1 | CareConnect-GPC-Organization-1 | CareConnect-GPC-Practitioner-1)
valueQuantityCareConnect-Quantity-1
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueAttachmentAttachment
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonS I0..1CodeableConceptBinding
interpretationS0..1CodeableConceptBinding
commentS0..1string
snomedCTDescriptionIDI0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
snomedCTDescriptionIDI0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
specimenS I0..1Reference(CareConnect-GPC-Specimen-1)
deviceS I0..1Reference(DeviceMetric | GPConnect-Device-1)
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
typeS0..1codeBinding
targetI1..1Reference(QuestionnaireResponse | Sequence | CareConnect-GPC-Observation-1)
snomedCTDescriptionIDI0..1Extension(Complex)
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
valueQuantityCareConnect-Quantity-1
valueCodeableConceptCodeableConcept
valueStringstring
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueAttachmentAttachment
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonS I0..1CodeableConceptBinding
interpretation0..1CodeableConceptBinding
referenceRange0..*see (referenceRange)
Observation
DefinitionMeasurements and simple assertions made about a patient, device or other subject.
Cardinality0...*
AliasVital Signs, Measurement, Results, Tests
Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as lab reports, etc.

Invariants
  • dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative
    contained.text.empty()
  • dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    contained.where(('#'+id in %resource.descendants().reference).not()).empty()
  • obs-7:If code is the same as a component code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
  • obs-6:dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
Mappings
  • rim:Entity. Role, or Act
  • workflow:Event
  • sct-concept:< 363787002 |Observable entity|
  • v2:OBX
  • rim:Observation[classCode=OBS, moodCode=EVN]
  • w5:clinical.diagnostics
Observation.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
Observation.meta.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
SummaryTrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url]().
Cardinality1...*
Typeuri
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
Observation.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...*
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

Common Tags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
Observation.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

Common Languages (extensible)
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).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.text
DefinitionA human-readable narrative that contains a summary of the resource, and may 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
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 in formation is added later.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
  • rim:Act.text?
Observation.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained 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.

Mappings
  • rim:Entity. Role, or Act
  • rim:N/A
Observation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.extension:reason
DefinitionReason resource added/performed/given.
Cardinality0...*
TypeExtension(Reference(CareConnect-Condition-1), CodeableConcept)
Must SupportTrue
Aliasextensions, user content
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.identifier
DefinitionA unique identifier assigned to this observation.
Cardinality1...*
TypeIdentifier
SummaryTrue
Requirements

Allows observations to be distinguished and referenced.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd:Identifier
  • workflow:Event.identifier
  • v2:OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
  • rim:id
  • w5:id
Observation.identifier.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:N/A
  • rim:Role.code or implied by context
Observation.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:CX.5
  • rim:Role.code or implied by context
Observation.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

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

http://www.acme.com/identifiers/patient


Mappings
  • rim:n/a
  • v2:CX.4 / EI-2-4
  • rim:II.root or Role.id.root
  • servd:./IdentifierType
Observation.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

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

123456


Mappings
  • rim:n/a
  • v2:CX.1 / EI.1
  • rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd:./Value
Observation.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.empty() or end.empty() or (start <= end)
Mappings
  • rim:n/a
  • v2:DR
  • rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2:CX.7 + CX.8
  • rim:Role.effectiveTime or implied by context
  • servd:./StartDate and ./EndDate
Observation.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(CareConnect-GPC-Organization-1)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2:CX.4 / (CX.4,CX.9,CX.10)
  • rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd:./IdentifierIssuingAuthority
Observation.basedOn
DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event.
Cardinality0...*
TypeReference(CareConnect-CarePlan-1 | DeviceRequest | ImmunizationRecommendation | NutritionOrder | CareConnect-GPC-ProcedureRequest-1 | CareConnect-GPC-ReferralRequest-1 | CareConnect-GPC-MedicationRequest-1)
SummaryTrue
AliasFulfills
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow:Event.basedOn
  • v2:ORC
  • rim:.outboundRelationship[typeCode=FLFS].target
Observation.status
DefinitionThe status of the result value. In GP systems these are most likely to be ‘final’ however ‘preliminary’ reports are possible as for example, some work can be sub-contracted to other labs. If the system is not able to determine the status of a test group header then it should default to the ‘unknown’ value.
Cardinality1...1
Typecode
Binding

Codes providing the status of an observation.

ObservationStatus (required)
ModifierTrue
SummaryTrue
Requirements

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.status
  • sct-concept:< 445584004 |Report by finality status|
  • v2:OBX-11
  • rim:status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"
  • w5:status
Observation.category
DefinitionA code that classifies the general type of observation being made.
Cardinality0...*
TypeCodeableConcept
Binding

Codes for high level observation categories.

Observation Category Codes (preferred)
Requirements

Used for filtering what observations are retrieved and displayed.

Comments

In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • w5:class
Observation.category.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.category.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.category.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

SlicingUnordered, Open, by system(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.category.coding:snomedCT
DefinitionA reference to a code defined by a terminology system.
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.category.coding:snomedCT.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.category.coding:snomedCT.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.category.coding:snomedCT.extension:snomedCTDescriptionID
DefinitionThe SNOMED CT Description ID for the display.
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.category.coding:snomedCT.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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

http://snomed.info/sct

Mappings
  • rim:n/a
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.category.coding:snomedCT.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.category.coding:snomedCT.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.category.coding:snomedCT.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.category.coding:snomedCT.userSelected
DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Observation.category.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.9. But note many systems use C*E.2 for this
  • rim:./originalText[mediaType/code="text/plain"]/data
  • orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.code
DefinitionDescribes what was observed. Sometimes this is called the observation "name".
Cardinality1...1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINC Codes (example)
SummaryTrue
AliasName
Requirements

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

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow:Event.code
  • sct-concept:< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2:OBX-3
  • rim:code
  • sct-attr:116680003 |Is a|
  • w5:what
Observation.code.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.code.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.code.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

SlicingUnordered, Open, by system(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.code.coding:snomedCT
DefinitionA reference to a code defined by a terminology system.
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.code.coding:snomedCT.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.code.coding:snomedCT.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.code.coding:snomedCT.extension:snomedCTDescriptionID
DefinitionThe SNOMED CT Description ID for the display.
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.code.coding:snomedCT.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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

http://snomed.info/sct

Mappings
  • rim:n/a
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.code.coding:snomedCT.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.code.coding:snomedCT.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.code.coding:snomedCT.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.code.coding:snomedCT.userSelected
DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Observation.code.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.9. But note many systems use C*E.2 for this
  • rim:./originalText[mediaType/code="text/plain"]/data
  • orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.subject
DefinitionThe patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
Cardinality1...1
TypeReference(CareConnect-GPC-Patient-1)
Must SupportTrue
SummaryTrue
Requirements

Observations have no value if you don't know who or what they're about.

Comments

One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.

If the target of the observation is different than the subject, the general extension observation-focal-subject. may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow:Event.subject
  • v2:PID-3
  • rim:participation[typeCode=SBJ]
  • w5:who.focus
Observation.context
DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
Cardinality0...1
TypeReference(CareConnect-GPC-Encounter-1)
Must SupportTrue
AliasEncounter
Requirements

For some observations it may be important to know the link between an observation and a particular encounter.

Comments

This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow:Event.context
  • v2:PV1
  • rim:inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
  • w5:context
Observation.effective[x]
DefinitionThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
Cardinality0...1
TypedateTime, Period
Must SupportTrue
SummaryTrue
AliasOccurrence
Requirements

Knowing when an observation was deemed true is important to its relevance as well as determining trends.

Comments

At least a date should be present unless this observation is a historical report.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.occurrence[x]
  • v2:OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
  • rim:effectiveTime
  • w5:when.done
Observation.issued
DefinitionThe date and time this observation was made available to providers, typically after the results have been reviewed and verified.
Cardinality1...1
Typeinstant
Must SupportTrue
SummaryTrue
Comments

Updated when the result is updated.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
  • rim:participation[typeCode=AUT].time
  • w5:when.recorded
Observation.performer
DefinitionWho was responsible for asserting the observed value as "true".
Cardinality0...*
TypeReference(CareConnect-RelatedPerson-1 | CareConnect-GPC-Patient-1 | CareConnect-GPC-Organization-1 | CareConnect-GPC-Practitioner-1)
Must SupportTrue
SummaryTrue
Requirements

May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow:Event.performer
  • v2:OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
  • rim:participation[typeCode=PRF]
  • w5:who.actor
Observation.value[x]
DefinitionThe information determined as a result of making the observation, if the information has a simple value.
Cardinality0...1
TypeCareConnect-Quantity-1, CodeableConcept, string, boolean, Range, Ratio, SampledData, Attachment, time, dateTime, Period
Must SupportTrue
SummaryTrue
Requirements

An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.

Comments

Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type).

If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the notes section below.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.notDone, Event.notDoneReason (maps to valeu[x] or dataAbsentReason)
  • sct-concept:< 441742003 |Evaluation finding|
  • v2:OBX.2, OBX.5, OBX.6
  • rim:value
  • sct-attr:363714003 |Interprets|
Observation.dataAbsentReason
DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing.
Cardinality0...1
TypeCodeableConcept
Binding

Codes specifying why the result (Observation.value[x]) is missing.

Observation Value Absent Reason (extensible)
Must SupportTrue
Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow:Event.notDone, Event.notDoneReason (maps to valeu[x] or dataAbsentReason)
  • v2:N/A
  • rim:value.nullFlavor
Observation.interpretation
DefinitionA human readable clinical summary relating to a test result and/or additional notes provided by the laboratory e.g. the specimen has haemolysed or has leaked
Cardinality0...1
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

CareConnect Observation Interpretation (extensible)
Must SupportTrue
AliasAbnormal Flag
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • sct-concept:< 260245000 |Findings values|
  • v2:OBX-8
  • rim:interpretationCode
  • sct-attr:363713009 |Has interpretation|
Observation.comment
DefinitionMay include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
Cardinality0...1
Typestring
Must SupportTrue
Requirements

Need to be able to provide free text additional information.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.note
  • v2:NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
  • rim:subjectOf.observationEvent[code="annotation"].value
Observation.bodySite
DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site).
Cardinality0...1
TypeCodeableConcept
Binding

Codes describing anatomical locations. May include laterality.

SNOMED CT Body Structures (example)
Must SupportTrue
Comments

Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension body-site-instance.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • sct-concept:< 123037004 |Body structure|
  • v2:OBX-20
  • rim:targetSiteCode
  • sct-attr:718497002 |Inherent location|
Observation.bodySite.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.bodySite.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.bodySite.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

SlicingUnordered, Open, by system(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.bodySite.coding:snomedCT
DefinitionA reference to a code defined by a terminology system.
Cardinality0...1
TypeCoding
Binding

A code from the SNOMED Clinical Terminology UK with the expression (<<442083009 |anatomical or acquired body structure|).

Care Connect Body Site (preferred)
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.bodySite.coding:snomedCT.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.bodySite.coding:snomedCT.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.bodySite.coding:snomedCT.extension:snomedCTDescriptionID
DefinitionThe SNOMED CT Description ID for the display.
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.bodySite.coding:snomedCT.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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

http://snomed.info/sct

Mappings
  • rim:n/a
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.bodySite.coding:snomedCT.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.bodySite.coding:snomedCT.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.bodySite.coding:snomedCT.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.bodySite.coding:snomedCT.userSelected
DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Observation.bodySite.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.9. But note many systems use C*E.2 for this
  • rim:./originalText[mediaType/code="text/plain"]/data
  • orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.method
DefinitionIndicates the mechanism used to perform the observation.
Cardinality0...1
TypeCodeableConcept
Binding

Methods for simple observations.

Observation Methods (example)
Must SupportTrue
Requirements

In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.

Comments

Only used if not implicit in code for Observation.code.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:OBX-17
  • rim:methodCode
Observation.method.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.method.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.method.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

SlicingUnordered, Open, by system(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.method.coding:snomedCT
DefinitionA reference to a code defined by a terminology system.
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.method.coding:snomedCT.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.method.coding:snomedCT.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.method.coding:snomedCT.extension:snomedCTDescriptionID
DefinitionThe SNOMED CT Description ID for the display.
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.method.coding:snomedCT.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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

http://snomed.info/sct

Mappings
  • rim:n/a
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.method.coding:snomedCT.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.method.coding:snomedCT.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.method.coding:snomedCT.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.method.coding:snomedCT.userSelected
DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Observation.method.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.9. But note many systems use C*E.2 for this
  • rim:./originalText[mediaType/code="text/plain"]/data
  • orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.specimen
DefinitionThe specimen that was used when this observation was made.
Cardinality0...1
TypeReference(CareConnect-GPC-Specimen-1)
Must SupportTrue
Comments

Should only be used if not implicit in code found in Observation.code. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • sct-concept:< 123038009 |Specimen|
  • v2:SPM segment
  • rim:participation[typeCode=SPC].specimen
  • sct-attr:704319004 |Inherent in|
Observation.device
DefinitionThe device used to generate the observation data.
Cardinality0...1
TypeReference(DeviceMetric | GPConnect-Device-1)
Must SupportTrue
Comments

An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either an extension or through the Observation.related element.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • sct-concept:< 49062001 |Device|
  • v2:OBX-17 / PRT -10
  • rim:participation[typeCode=DEV]
  • sct-attr:424226004 |Using device|
Observation.referenceRange
DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • obs-3:Must have at least a low or a high or text
    low.exists() or high.exists() or text.exists()
Mappings
  • rim:n/a
  • v2:OBX.7
  • rim:outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
Observation.referenceRange.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.referenceRange.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.referenceRange.modifierExtension
DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.referenceRange.low
DefinitionThe value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
Cardinality0...1
TypeSimpleQuantity
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • qty-3:If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • sqty-1:The comparator is not used on a SimpleQuantity
    comparator.empty()
Mappings
  • rim:n/a
  • v2:SN (see also Range) or CQ
  • rim:PQ, IVL<PQ>, MO, CO, depending on the values
  • v2:OBX-7
  • rim:value:IVL_PQ.low
Observation.referenceRange.high
DefinitionThe value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
Cardinality0...1
TypeSimpleQuantity
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • qty-3:If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • sqty-1:The comparator is not used on a SimpleQuantity
    comparator.empty()
Mappings
  • rim:n/a
  • v2:SN (see also Range) or CQ
  • rim:PQ, IVL<PQ>, MO, CO, depending on the values
  • v2:OBX-7
  • rim:value:IVL_PQ.high
Observation.referenceRange.type
DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
Cardinality0...1
TypeCodeableConcept
Binding

Code for the meaning of a reference range.

Observation Reference Range Meaning Codes (extensible)
Requirements

Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc, - for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • sct-concept:< 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
  • v2:OBX-10
  • rim:interpretationCode
Observation.referenceRange.appliesTo
DefinitionCodes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race.
Cardinality0...*
TypeCodeableConcept
Binding

Codes identifying the population the reference range applies to.

Observation Reference Range Applies To Codes (example)
Requirements

Need to be able to identify the target population for proper interpretation.

Comments

This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • sct-concept:< 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
  • v2:OBX-10
  • rim:interpretationCode
Observation.referenceRange.age
DefinitionThe 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.
Cardinality0...1
TypeRange
Requirements

Some analytes vary greatly over age.

Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • rng-2:If present, low SHALL have a lower value than high
    low.empty() or high.empty() or (low <= high)
Mappings
  • rim:n/a
  • v2:NR and also possibly SN (but see also quantity)
  • rim:IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
  • rim:outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value
Observation.referenceRange.text
DefinitionText based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:OBX-7
  • rim:value:ST
Observation.related
DefinitionA reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
SummaryTrue
Requirements

Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes a QuestionnaireResponse from which the measure is derived.

Comments

For a discussion on the ways Observations can assembled in groups together see Notes below.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Relationships established by OBX-4 usage
  • rim:outBoundRelationship
Observation.related.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.related.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.related.modifierExtension
DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.related.type
DefinitionA code specifying the kind of relationship that exists with the target resource.
Cardinality0...1
Typecode
Binding

Codes specifying how two observations are related.

ObservationRelationshipType (required)
Must SupportTrue
Requirements

A relationship type SHOULD be provided.

Comments

The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswer resource.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:N/A
  • rim:.typeCode
Observation.related.target
DefinitionA reference to the observation or [QuestionnaireResponse](questionnaireresponse.html#) resource that is related to this observation.
Cardinality1...1
TypeReference(QuestionnaireResponse | Sequence | CareConnect-GPC-Observation-1)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:.targetObservation
Observation.component
DefinitionSome observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
SummaryTrue
Requirements

Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.

Comments

For a discussion on the ways Observations can be assembled in groups together see Notes below.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:containment by OBX-4?
  • rim:outBoundRelationship[typeCode=COMP]
Observation.component.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.component.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.component.modifierExtension
DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.component.code
DefinitionDescribes what was observed. Sometimes this is called the observation "code".
Cardinality1...1
TypeCodeableConcept
Binding

Codes identifying names of simple observations.

LOINC Codes (example)
SummaryTrue
Requirements

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

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • sct-concept:< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
  • v2:OBX-3
  • rim:code
  • w5:what
Observation.component.code.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.component.code.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.component.code.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

SlicingUnordered, Open, by system(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component.code.coding:snomedCT
DefinitionA reference to a code defined by a terminology system.
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Observation.component.code.coding:snomedCT.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Observation.component.code.coding:snomedCT.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.component.code.coding:snomedCT.extension:snomedCTDescriptionID
DefinitionThe SNOMED CT Description ID for the display.
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Observation.component.code.coding:snomedCT.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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

http://snomed.info/sct

Mappings
  • rim:n/a
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Observation.component.code.coding:snomedCT.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Observation.component.code.coding:snomedCT.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Observation.component.code.coding:snomedCT.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Observation.component.code.coding:snomedCT.userSelected
DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Observation.component.code.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.9. But note many systems use C*E.2 for this
  • rim:./originalText[mediaType/code="text/plain"]/data
  • orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Observation.component.value[x]
DefinitionThe information determined as a result of making the observation, if the information has a simple value.
Cardinality0...1
TypeCareConnect-Quantity-1, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period
SummaryTrue
Requirements

An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.

Comments

Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from http://hl7.org/fhir/ValueSet/v2-0136 (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • sct-concept:363714003 |Interprets| < 441742003 |Evaluation finding|
  • v2:OBX.2, OBX.5, OBX.6
  • rim:value
  • sct-attr:363714003 |Interprets|
Observation.component.dataAbsentReason
DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing.
Cardinality0...1
TypeCodeableConcept
Binding

Codes specifying why the result (Observation.value[x]) is missing.

Observation Value Absent Reason (extensible)
Must SupportTrue
Requirements

For many results it is necessary to handle exceptional values in measurements.

Comments

"Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:N/A
  • rim:value.nullFlavor
Observation.component.interpretation
DefinitionThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
Cardinality0...1
TypeCodeableConcept
Binding

Codes identifying interpretations of observations.

Observation Interpretation Codes (extensible)
AliasAbnormal Flag
Requirements

For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.

Comments

The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • sct-concept:< 260245000 |Findings values|
  • v2:OBX-8
  • rim:interpretationCode
  • sct-attr:363713009 |Has interpretation|
Observation.component.referenceRange
DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range.
Cardinality0...*
Typesee (referenceRange)
Requirements

Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.

Comments

Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.

Mappings
  • v2:OBX.7
  • rim:outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

category

Expected to be vital-signs or social-history for this specification.

https://simplifier.net/packages/hl7.fhir.r3.core/3.0.2/files/58207

Code Display Definition
social-history Social History The Social History Observations define the patient's occupational, personal (e.g. lifestyle), social, and environmental history and health risk factors, as well as administrative data such as marital status, race, ethnicity and religious affiliation.
vital-signs Vital Signs Clinical observations measure the body's basic functions such as such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area.

back to top