SDOH Clinical Care
1.1.0 - STU 2 ballot

This page is part of the SDOH Clinical Care for Multiple Domains (v1.1.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: SDOHCC Observation Ethnicity

Defining URL:http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicity
Version:1.1.0
Name:SDOHCCObservationEthnicity
Title:SDOHCC Observation Ethnicity
Status:Draft as of 12/7/21 2:30 PM
Definition:

Profile for observations about ethnicity using Office of Management and Budget (OMB) ethnicity category codes and CDC ethnicity codes. This profile is intended for draft use only. The Cross-Group Projects work group granted an exception to US Core on 11/18/2021 - Jira ticket 34245.

Publisher:HL7 International - Patient Care WG
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicity

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Observation

Summary

Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 17 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the values of pattern:code, type:value, value:value

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationEthnicity observation
SDOH-Obs-1: Must have either a dataAbsentReason or at least one of the defined ethnicity components but not both
SDOH-Obs-2: Must have either performer or derivedFrom.
SDOH-Obs-3: Either subject or extension-Observation.subject must exist but not both.
SDOH-Obs-4: focus is only allowed if subject is present.
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-Observation.subject SI0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject
.... value[x] 0..1Reference(US Core Practitioner Profile)Value of extension
... status S1..1coderegistered | preliminary | final | amended +
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
... subject SI1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus I0..1Reference(RelatedPerson)What the observation is about, when it is not about the subject of record
... performer SI0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] 0..0
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: SDOHCC ValueSet Observation DataAbsentReason (required)
... bodySite 0..0
... method S1..1CodeableConceptHow it was done
Binding: SDOHCC ValueSet Observation Method (extensible)
... specimen 0..0
... referenceRange 0..0
... derivedFrom SI0..*Reference(DocumentReference | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SI0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code, type:value, value:value
.... component:EthnicityDescription SI0..1BackboneElementComponent results
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] S1..1stringActual component result
..... dataAbsentReason 0..0
..... referenceRange 0..0
.... component:Ethnicity S0..1BackboneElementComponent results
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] S1..1CodeableConceptHispanic or Latino | Non Hispanic or Latino
Binding: OMB Ethnicity Categories (required): Codes for the two OMB ethnicity categories

..... dataAbsentReason 0..0
..... referenceRange 0..0
.... component:DetailedEthnicity 0..*BackboneElementComponent results
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] S1..1CodeableConceptActual component result
Binding: Detailed ethnicity (required): CDC ethnicity codes that are under one of the 2 OMB ethnicity category codes

..... dataAbsentReason 0..0
..... referenceRange 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationEthnicity observation
SDOH-Obs-1: Must have either a dataAbsentReason or at least one of the defined ethnicity components but not both
SDOH-Obs-2: Must have either performer or derivedFrom.
SDOH-Obs-3: Either subject or extension-Observation.subject must exist but not both.
SDOH-Obs-4: focus is only allowed if subject is present.
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-Observation.subject SI0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1Reference(US Core Practitioner Profile)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣI1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus ΣI0..1Reference(RelatedPerson)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer SΣI0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: SDOHCC ValueSet Observation DataAbsentReason (required)
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... method S1..1CodeableConceptHow it was done
Binding: SDOHCC ValueSet Observation Method (extensible)
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom SΣI0..*Reference(DocumentReference | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SΣI0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code, type:value, value:value
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:EthnicityDescription SΣI0..1BackboneElementComponent results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1stringActual component result
..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... component:Ethnicity SΣ0..1BackboneElementComponent results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1CodeableConceptHispanic or Latino | Non Hispanic or Latino
Binding: OMB Ethnicity Categories (required): Codes for the two OMB ethnicity categories

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... component:DetailedEthnicity Σ0..*BackboneElementComponent results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1CodeableConceptActual component result
Binding: Detailed ethnicity (required): CDC ethnicity codes that are under one of the 2 OMB ethnicity category codes

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.



doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationEthnicity observation
SDOH-Obs-1: Must have either a dataAbsentReason or at least one of the defined ethnicity components but not both
SDOH-Obs-2: Must have either performer or derivedFrom.
SDOH-Obs-3: Either subject or extension-Observation.subject must exist but not both.
SDOH-Obs-4: focus is only allowed if subject is present.
... extension-Observation.subject I0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
... performer ΣI0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: SDOHCC ValueSet Observation DataAbsentReason (required)
... method 1..1CodeableConceptHow it was done
Binding: SDOHCC ValueSet Observation Method (extensible)
... derivedFrom ΣI0..*Reference(DocumentReference | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component ΣI0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code, type:value, value:value
.... component:EthnicityDescription ΣI0..1BackboneElementComponent results
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] Σ1..1stringActual component result
.... component:Ethnicity Σ0..1BackboneElementComponent results
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] Σ1..1CodeableConceptHispanic or Latino | Non Hispanic or Latino
Binding: OMB Ethnicity Categories (required): Codes for the two OMB ethnicity categories

.... component:DetailedEthnicity Σ0..*BackboneElementComponent results
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] Σ1..1CodeableConceptActual component result
Binding: Detailed ethnicity (required): CDC ethnicity codes that are under one of the 2 OMB ethnicity category codes


doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 17 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the values of pattern:code, type:value, value:value

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationEthnicity observation
SDOH-Obs-1: Must have either a dataAbsentReason or at least one of the defined ethnicity components but not both
SDOH-Obs-2: Must have either performer or derivedFrom.
SDOH-Obs-3: Either subject or extension-Observation.subject must exist but not both.
SDOH-Obs-4: focus is only allowed if subject is present.
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-Observation.subject SI0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject
.... value[x] 0..1Reference(US Core Practitioner Profile)Value of extension
... status S1..1coderegistered | preliminary | final | amended +
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
... subject SI1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus I0..1Reference(RelatedPerson)What the observation is about, when it is not about the subject of record
... performer SI0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] 0..0
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: SDOHCC ValueSet Observation DataAbsentReason (required)
... bodySite 0..0
... method S1..1CodeableConceptHow it was done
Binding: SDOHCC ValueSet Observation Method (extensible)
... specimen 0..0
... referenceRange 0..0
... derivedFrom SI0..*Reference(DocumentReference | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SI0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code, type:value, value:value
.... component:EthnicityDescription SI0..1BackboneElementComponent results
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] S1..1stringActual component result
..... dataAbsentReason 0..0
..... referenceRange 0..0
.... component:Ethnicity S0..1BackboneElementComponent results
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] S1..1CodeableConceptHispanic or Latino | Non Hispanic or Latino
Binding: OMB Ethnicity Categories (required): Codes for the two OMB ethnicity categories

..... dataAbsentReason 0..0
..... referenceRange 0..0
.... component:DetailedEthnicity 0..*BackboneElementComponent results
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... value[x] S1..1CodeableConceptActual component result
Binding: Detailed ethnicity (required): CDC ethnicity codes that are under one of the 2 OMB ethnicity category codes

..... dataAbsentReason 0..0
..... referenceRange 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationEthnicity observation
SDOH-Obs-1: Must have either a dataAbsentReason or at least one of the defined ethnicity components but not both
SDOH-Obs-2: Must have either performer or derivedFrom.
SDOH-Obs-3: Either subject or extension-Observation.subject must exist but not both.
SDOH-Obs-4: focus is only allowed if subject is present.
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-Observation.subject SI0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance)Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1Reference(US Core Practitioner Profile)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣI1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus ΣI0..1Reference(RelatedPerson)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer SΣI0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: SDOHCC ValueSet Observation DataAbsentReason (required)
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... method S1..1CodeableConceptHow it was done
Binding: SDOHCC ValueSet Observation Method (extensible)
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom SΣI0..*Reference(DocumentReference | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SΣI0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code, type:value, value:value
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:EthnicityDescription SΣI0..1BackboneElementComponent results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1stringActual component result
..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... component:Ethnicity SΣ0..1BackboneElementComponent results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1CodeableConceptHispanic or Latino | Non Hispanic or Latino
Binding: OMB Ethnicity Categories (required): Codes for the two OMB ethnicity categories

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... component:DetailedEthnicity Σ0..*BackboneElementComponent results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 69490-1
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1CodeableConceptActual component result
Binding: Detailed ethnicity (required): CDC ethnicity codes that are under one of the 2 OMB ethnicity category codes

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.



doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexamplePattern: LOINC code 69490-1
Observation.dataAbsentReasonrequiredSDOHCCValueSetObservationDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.methodextensibleSDOHCCValueSetObservationMethod
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:EthnicityDescription.codeexamplePattern: LOINC code 69490-1
Observation.component:EthnicityDescription.interpretationextensibleObservationInterpretationCodes
Observation.component:Ethnicity.codeexamplePattern: LOINC code 69490-1
Observation.component:Ethnicity.value[x]requiredOmbEthnicityCategories
Observation.component:Ethnicity.interpretationextensibleObservationInterpretationCodes
Observation.component:DetailedEthnicity.codeexamplePattern: LOINC code 69490-1
Observation.component:DetailedEthnicity.value[x]requiredDetailedEthnicity
Observation.component:DetailedEthnicity.interpretationextensibleObservationInterpretationCodes

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ObservationIf 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-4ObservationIf 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-5ObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ObservationA resource should have narrative for robust management
: text.`div`.exists()
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7ObservationIf 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()
SDOH-Obs-1ObservationMust have either a dataAbsentReason or at least one of the defined ethnicity components but not both
: dataAbsentReason.exists() xor component.where(code.coding.where(system='http://loinc.org' and code='69490-1')).exists()
SDOH-Obs-2ObservationMust have either performer or derivedFrom.
: performer.exists() or derivedFrom.exists()
SDOH-Obs-3ObservationEither subject or extension-Observation.subject must exist but not both.
: subject.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject').exists()
SDOH-Obs-4Observationfocus is only allowed if subject is present.
: focus.exists() implies subject.exists()
ele-1Observation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.extension:OtherSubjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extension:OtherSubjectMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.extension:OtherSubject.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extension:OtherSubject.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.extension:OtherSubject.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.deviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.lowAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.highAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMemberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.derivedFromAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.componentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:EthnicityDescriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:EthnicityDescription.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component:EthnicityDescription.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component:EthnicityDescription.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component:EthnicityDescription.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component:EthnicityDescription.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:EthnicityDescription.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:EthnicityDescription.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:EthnicityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:Ethnicity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component:Ethnicity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component:Ethnicity.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component:Ethnicity.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component:Ethnicity.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:Ethnicity.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:Ethnicity.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:DetailedEthnicityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:DetailedEthnicity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component:DetailedEthnicity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component:DetailedEthnicity.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component:DetailedEthnicity.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component:DetailedEthnicity.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:DetailedEthnicity.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component:DetailedEthnicity.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())