US Public Health Profiles Library
2.0.0-ballot - STU 2.0.0 - Ballot United States of America flag

US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Exposure Contact Information

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-exposure-contact-information Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USPublicHealthExposureContactInformation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.29

This Observation profile represents potential patient exposure and contact information.

It is based on the US Core Simple Observation Profile profile and further constrains it:

  • sets Observation.category[us-core] to "social-history social history"
  • sets Observation.category[exposure] to "TRNS exposure"
  • binds to suggested value sets for use in Observation.code
  • further constrains Observation.subject to the US Public Health Patient

Profile Use Guidance:

  • Observation.extension[address]: if known, an address where the exposure/contact took place
  • Observation.code: The type of exposure/contact (environmental, activity, event, location, person, animal, etc.).
  • Observation.focus: A reference to a Patient, RelatedPerson, Location, Group, etc. when the exposure/contact is an entity (person, animal, location)
    • an animal would be represented by a RelatedPerson that contains the Extension Practitioner Animal Species.
  • Observation.valueString: free text information about the exposure/contact
  • Observation.effective[x]: the date or period of exposure
  • Observation.component: the possible agent of concern in the exposure

The following are some exposures that might be captured in this profile:

  • Environmental exposures
    • Living facilities
    • Work facilities
    • School facilities
  • Contact exposures
    • Person
    • Animal
  • Event Exposures
    • Sporting event
    • Rally
    • Wedding
    • Activity

Represented USCDI+ Data Elements

Use Case Data Class Data Element Name
Case Reporting Exposure/Contact Information Exposure/Contact Date
Case Reporting Exposure/Contact Information Exposure/Contact Direction
Case Reporting Exposure/Contact Information Exposure/Contact Source/Target Participant
Case Reporting Exposure/Contact Information Exposure/Contact Type

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile US Public Health Exposure Contact Information
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Exposure/contact address
Slice: Unordered, Open by value:url
.... extension:address S 0..1 Address US Public Health Address Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:exposure S 1..1 CodeableConcept (USCDI+) Exposure/Contact Direction
Binding: ActClassExposure (3.0.0) (required)
... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Type
Binding: LOINCCodes (preferred)
.... Slices for coding Σ 0..* Coding Each slice contains a suggested value set, but values are not restricted to these value sets.
Slice: Unordered, Open by value:$this
..... coding:exposureSetting SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Setting (COVID-19) (required)
..... coding:exposureLocation SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Location (required)
..... coding:exposureSocial SΣ 0..1 Coding Code defined by a terminology system
Binding: SocialHistoryTypeSCT (20250422) . (required)
... subject SΣ 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
... focus SΣ 0..* Reference(US Public Health Patient | RelatedPerson | Group | US Public Health Location) (USCDI+) Exposure/Contact Source/Target Participant
... effective[x] SΣ 0..1 (USCDI+) Exposure/Contact Date
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 Specific exposure/contact
.... valueCodeableConcept CodeableConcept S
.... valueString string S
... component SΣ 0..* BackboneElement Possible agent of concern in the exposure
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Agent
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EXPAGNT
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] SΣ 1..1 Actual component result
..... valueCodeableConcept CodeableConcept
..... valueString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
From the FHIR Standard
Observation.category:us-corerequiredPattern Value: social-history
http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category
Observation.category:exposurerequiredActClassExposure
http://terminology.hl7.org/ValueSet/v3-ActClassExposure|3.0.0
Observation.codepreferredLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.code.coding:exposureSettingrequiredPHVS_ExposureSetting_COVID-19
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7942
Observation.code.coding:exposureLocationrequiredPHVS_ExposureLocation_CDC
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3209
Observation.code.coding:exposureSocialrequiredSocialHistoryTypeSCT .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60|20250422
Observation.component.codeexamplePattern Value: EXPAGNT
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCoreSimpleObservationProfile US Public Health Exposure Contact Information
... Slices for extension 0..* Extension Exposure/contact address
Slice: Unordered, Open by value:url
.... extension:address S 0..1 Address US Public Health Address Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
... Slices for category Content/Rules for all slices
.... category:us-core 0..* CodeableConcept (USCDI) Classification of type of observation
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
.... category:exposure S 1..1 CodeableConcept (USCDI+) Exposure/Contact Direction
Binding: ActClassExposure (3.0.0) (required)
... code 1..1 CodeableConcept (USCDI+) Exposure/Contact Type
.... Slices for coding 0..* Coding Each slice contains a suggested value set, but values are not restricted to these value sets.
Slice: Unordered, Open by value:$this
..... coding:exposureSetting S 0..1 Coding Code defined by a terminology system
Binding: Exposure Setting (COVID-19) (required)
..... coding:exposureLocation S 0..1 Coding Code defined by a terminology system
Binding: Exposure Location (required)
..... coding:exposureSocial S 0..1 Coding Code defined by a terminology system
Binding: SocialHistoryTypeSCT (20250422) . (required)
... focus S 0..* Reference(US Public Health Patient | RelatedPerson | Group | US Public Health Location) (USCDI+) Exposure/Contact Source/Target Participant
... effective[x] 0..1 dateTime, Period, Timing, instant (USCDI+) Exposure/Contact Date
... value[x] 0..1 Specific exposure/contact
.... valueCodeableConcept CodeableConcept
.... valueString string
... component S 0..* BackboneElement Possible agent of concern in the exposure
.... code S 1..1 CodeableConcept (USCDI+) Exposure/Contact Agent
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EXPAGNT
.... value[x] S 1..1 Actual component result
..... valueCodeableConcept CodeableConcept
..... valueString string

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.category:exposurerequiredActClassExposure
http://terminology.hl7.org/ValueSet/v3-ActClassExposure|3.0.0
Observation.code.coding:exposureSettingrequiredPHVS_ExposureSetting_COVID-19
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7942
Observation.code.coding:exposureLocationrequiredPHVS_ExposureLocation_CDC
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3209
Observation.code.coding:exposureSocialrequiredSocialHistoryTypeSCT .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60|20250422
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile US Public Health Exposure Contact Information
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Exposure/contact address
Slice: Unordered, Open by value:url
.... extension:address S 0..1 Address US Public Health Address Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business 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..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:exposure S 1..1 CodeableConcept (USCDI+) Exposure/Contact Direction
Binding: ActClassExposure (3.0.0) (required)
... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Type
Binding: LOINCCodes (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Each slice contains a suggested value set, but values are not restricted to these value sets.
Slice: Unordered, Open by value:$this
..... coding:exposureSetting SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Setting (COVID-19) (required)
..... coding:exposureLocation SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Location (required)
..... coding:exposureSocial SΣ 0..1 Coding Code defined by a terminology system
Binding: SocialHistoryTypeSCT (20250422) . (required)
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
... focus SΣ 0..* Reference(US Public Health Patient | RelatedPerson | Group | US Public Health Location) (USCDI+) Exposure/Contact Source/Target Participant
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 (USCDI+) Exposure/Contact Date
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 Specific exposure/contact
.... valueCodeableConcept CodeableConcept S
.... valueString string S
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) (USCDI) US Core Profiles or other resource the observation is made from
... component SΣ 0..* BackboneElement Possible agent of concern in the exposure
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Agent
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EXPAGNT
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] SΣ 1..1 Actual component result
..... valueCodeableConcept CodeableConcept
..... valueString string
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
From the FHIR Standard
Observation.category:us-corerequiredPattern Value: social-history
http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category
Observation.category:exposurerequiredActClassExposure
http://terminology.hl7.org/ValueSet/v3-ActClassExposure|3.0.0
Observation.codepreferredLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.code.coding:exposureSettingrequiredPHVS_ExposureSetting_COVID-19
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7942
Observation.code.coding:exposureLocationrequiredPHVS_ExposureLocation_CDC
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3209
Observation.code.coding:exposureSocialrequiredSocialHistoryTypeSCT .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60|20250422
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
From the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
From the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
From the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
From the FHIR Standard
Observation.component.codeexamplePattern Value: EXPAGNT
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
From the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

This structure is derived from USCoreSimpleObservationProfile

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 9 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 1 is sliced based on the value of Observation.code.coding

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile US Public Health Exposure Contact Information
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Exposure/contact address
Slice: Unordered, Open by value:url
.... extension:address S 0..1 Address US Public Health Address Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:exposure S 1..1 CodeableConcept (USCDI+) Exposure/Contact Direction
Binding: ActClassExposure (3.0.0) (required)
... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Type
Binding: LOINCCodes (preferred)
.... Slices for coding Σ 0..* Coding Each slice contains a suggested value set, but values are not restricted to these value sets.
Slice: Unordered, Open by value:$this
..... coding:exposureSetting SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Setting (COVID-19) (required)
..... coding:exposureLocation SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Location (required)
..... coding:exposureSocial SΣ 0..1 Coding Code defined by a terminology system
Binding: SocialHistoryTypeSCT (20250422) . (required)
... subject SΣ 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
... focus SΣ 0..* Reference(US Public Health Patient | RelatedPerson | Group | US Public Health Location) (USCDI+) Exposure/Contact Source/Target Participant
... effective[x] SΣ 0..1 (USCDI+) Exposure/Contact Date
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 Specific exposure/contact
.... valueCodeableConcept CodeableConcept S
.... valueString string S
... component SΣ 0..* BackboneElement Possible agent of concern in the exposure
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Agent
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EXPAGNT
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] SΣ 1..1 Actual component result
..... valueCodeableConcept CodeableConcept
..... valueString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
From the FHIR Standard
Observation.category:us-corerequiredPattern Value: social-history
http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category
Observation.category:exposurerequiredActClassExposure
http://terminology.hl7.org/ValueSet/v3-ActClassExposure|3.0.0
Observation.codepreferredLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.code.coding:exposureSettingrequiredPHVS_ExposureSetting_COVID-19
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7942
Observation.code.coding:exposureLocationrequiredPHVS_ExposureLocation_CDC
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3209
Observation.code.coding:exposureSocialrequiredSocialHistoryTypeSCT .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60|20250422
Observation.component.codeexamplePattern Value: EXPAGNT
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

Differential View

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCoreSimpleObservationProfile US Public Health Exposure Contact Information
... Slices for extension 0..* Extension Exposure/contact address
Slice: Unordered, Open by value:url
.... extension:address S 0..1 Address US Public Health Address Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
... Slices for category Content/Rules for all slices
.... category:us-core 0..* CodeableConcept (USCDI) Classification of type of observation
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
.... category:exposure S 1..1 CodeableConcept (USCDI+) Exposure/Contact Direction
Binding: ActClassExposure (3.0.0) (required)
... code 1..1 CodeableConcept (USCDI+) Exposure/Contact Type
.... Slices for coding 0..* Coding Each slice contains a suggested value set, but values are not restricted to these value sets.
Slice: Unordered, Open by value:$this
..... coding:exposureSetting S 0..1 Coding Code defined by a terminology system
Binding: Exposure Setting (COVID-19) (required)
..... coding:exposureLocation S 0..1 Coding Code defined by a terminology system
Binding: Exposure Location (required)
..... coding:exposureSocial S 0..1 Coding Code defined by a terminology system
Binding: SocialHistoryTypeSCT (20250422) . (required)
... focus S 0..* Reference(US Public Health Patient | RelatedPerson | Group | US Public Health Location) (USCDI+) Exposure/Contact Source/Target Participant
... effective[x] 0..1 dateTime, Period, Timing, instant (USCDI+) Exposure/Contact Date
... value[x] 0..1 Specific exposure/contact
.... valueCodeableConcept CodeableConcept
.... valueString string
... component S 0..* BackboneElement Possible agent of concern in the exposure
.... code S 1..1 CodeableConcept (USCDI+) Exposure/Contact Agent
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EXPAGNT
.... value[x] S 1..1 Actual component result
..... valueCodeableConcept CodeableConcept
..... valueString string

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.category:exposurerequiredActClassExposure
http://terminology.hl7.org/ValueSet/v3-ActClassExposure|3.0.0
Observation.code.coding:exposureSettingrequiredPHVS_ExposureSetting_COVID-19
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7942
Observation.code.coding:exposureLocationrequiredPHVS_ExposureLocation_CDC
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3209
Observation.code.coding:exposureSocialrequiredSocialHistoryTypeSCT .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60|20250422

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile US Public Health Exposure Contact Information
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Exposure/contact address
Slice: Unordered, Open by value:url
.... extension:address S 0..1 Address US Public Health Address Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business 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..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: social-history
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:exposure S 1..1 CodeableConcept (USCDI+) Exposure/Contact Direction
Binding: ActClassExposure (3.0.0) (required)
... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Type
Binding: LOINCCodes (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Each slice contains a suggested value set, but values are not restricted to these value sets.
Slice: Unordered, Open by value:$this
..... coding:exposureSetting SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Setting (COVID-19) (required)
..... coding:exposureLocation SΣ 0..1 Coding Code defined by a terminology system
Binding: Exposure Location (required)
..... coding:exposureSocial SΣ 0..1 Coding Code defined by a terminology system
Binding: SocialHistoryTypeSCT (20250422) . (required)
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
... focus SΣ 0..* Reference(US Public Health Patient | RelatedPerson | Group | US Public Health Location) (USCDI+) Exposure/Contact Source/Target Participant
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 (USCDI+) Exposure/Contact Date
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 Specific exposure/contact
.... valueCodeableConcept CodeableConcept S
.... valueString string S
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) (USCDI) US Core Profiles or other resource the observation is made from
... component SΣ 0..* BackboneElement Possible agent of concern in the exposure
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 CodeableConcept (USCDI+) Exposure/Contact Agent
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EXPAGNT
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] SΣ 1..1 Actual component result
..... valueCodeableConcept CodeableConcept
..... valueString string
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
From the FHIR Standard
Observation.category:us-corerequiredPattern Value: social-history
http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category
Observation.category:exposurerequiredActClassExposure
http://terminology.hl7.org/ValueSet/v3-ActClassExposure|3.0.0
Observation.codepreferredLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.code.coding:exposureSettingrequiredPHVS_ExposureSetting_COVID-19
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7942
Observation.code.coding:exposureLocationrequiredPHVS_ExposureLocation_CDC
http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3209
Observation.code.coding:exposureSocialrequiredSocialHistoryTypeSCT .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.60|20250422
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
From the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
From the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
From the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
From the FHIR Standard
Observation.component.codeexamplePattern Value: EXPAGNT
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
From the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

This structure is derived from USCoreSimpleObservationProfile

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 9 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 1 is sliced based on the value of Observation.code.coding

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron