StructureDefinition UKCore-Observation-AlcoholConsumption

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 laboratory reports, etc.

• dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
  contained.contained.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 or SHALL refer to the containing resource
  contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
• dom-6: A resource should have narrative for robust management
  text.`div`.exists()
• dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
  contained.meta.security.empty()
• obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
  value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
• obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
  dataAbsentReason.empty() or value.empty()

• rim: Entity. Role, or Act
• workflow: Event
• sct-concept: < 363787002 |Observable entity|
• v2: OBX
• rim: Observation[classCode=OBS, moodCode=EVN]

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

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

• rim: n/a
• rim: N/A

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

• rim: n/a

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

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

• rim: n/a

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

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

• rim: n/a
• rim: N/A
• rim: Act.text?

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

• rim: Entity. Role, or Act
• rim: N/A

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.

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

• rim: n/a
• rim: N/A

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.

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

• rim: n/a
• rim: N/A

• rim: n/a

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.

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

• rim: n/a
• rim: N/A

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.

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

• rim: n/a
• rim: N/A

• rim: n/a

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.

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

• rim: n/a
• rim: N/A

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

observation

• rim: N/A

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

• rim: n/a
• rim: N/A

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.

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

• rim: n/a
• rim: N/A

• rim: n/a

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.

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

• rim: n/a
• rim: N/A

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

type

• rim: N/A

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

• rim: n/a
• rim: N/A

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.

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

• rim: n/a
• rim: N/A

• rim: n/a

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.

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

• rim: n/a
• rim: N/A

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

reason

• rim: N/A

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

• rim: n/a
• rim: N/A

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy

• rim: N/A

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

• rim: n/a
• rim: N/A

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.

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

• rim: n/a
• rim: N/A

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

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

• rim: n/a
• rim: N/A

Allows observations to be distinguished and referenced.

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

• rim: n/a
• v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
• rim: II - 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
• w5: FiveWs.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

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

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.

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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 %rootResource.contained.id.trace('ids'))

• 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: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

To link an Observation to an Encounter use encounter. See the Notes below for guidance on referencing another Observation.

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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 %rootResource.contained.id.trace('ids'))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow: Event.partOf
• v2: Varies by domain
• rim: .outboundRelationship[typeCode=FLFS].target

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

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

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

final

• rim: n/a
• workflow: Event.status
• w5: FiveWs.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"

Used for filtering what observations are retrieved and displayed.

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.

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

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• w5: FiveWs.class
• rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code

• rim: n/a

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.

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

• rim: n/a
• rim: N/A

Allows for alternative encodings within a code system, and translations to other code systems.

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.

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

• 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

• rim: n/a

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.

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

• rim: n/a
• rim: N/A

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

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 reference to some definition that establishes the system clearly and unambiguously.

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

http://terminology.hl7.org/CodeSystem/observation-category

• rim: n/a
• v2: C*E.3
• rim: ./codeSystem
• orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

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.

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

• rim: n/a
• v2: C*E.7
• rim: ./codeSystemVersion
• orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Need to refer to a particular code in the system.

Note that FHIR strings SHALL NOT exceed 1MB in size

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

social-history

• rim: n/a
• v2: C*E.1
• rim: ./code
• orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

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

Note that FHIR strings SHALL NOT exceed 1MB in size

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

• 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

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.

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.

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

• 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 ]

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.

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

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

• 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

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

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

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

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• workflow: Event.code
• w5: FiveWs.what[x]
• sct-concept: < 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
• v2: OBX-3
• rim: code
• sct-attr: 116680003 |Is a|

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

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.

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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 %rootResource.contained.id.trace('ids'))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow: Event.subject
• w5: FiveWs.subject[x]
• v2: PID-3
• rim: participation[typeCode=RTGT]
• w5: FiveWs.subject

Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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 %rootResource.contained.id.trace('ids'))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• w5: FiveWs.subject[x]
• v2: OBX-3
• rim: participation[typeCode=SBJ]
• w5: FiveWs.subject

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

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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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 %rootResource.contained.id.trace('ids'))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow: Event.context
• w5: FiveWs.context
• v2: PV1
• rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]

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

At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events.

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

• rim: n/a
• workflow: Event.occurrence[x]
• w5: FiveWs.done[x]
• v2: OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
• rim: effectiveTime