US Public Health Profiles Library
​2.0.0 - 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 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 Travel History

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-travel-history Version: 2.0.0
Standards status: Trial-use Active as of 2025-10-23 Maturity Level: 3 Computable Name: USPublicHealthTravelHistory
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.61

This Observation profile represents a patient's travel history.

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

The following data for a patient can be recorded:

  • travel history as a string, an address, or a coded location
  • the date or period of time spent in the location (Observation.effectiveTime)
    • it is important to capture the most accurate dates possible
    • the focus should be on date of arrival and date of departure
    • the concepts of dates as related to travel are especially useful for determining need for Federal Public Health Notifications (FPHNs) and these dates are used to alert foreign ministries of health about their residents who may have been contacts of cases, or if a flight that was outbound from the USA had an infectious traveler on it
  • most uses will involve a single location (Observation.component), however, it is possible to specify multiple locations (but there is only a single effectiveTime)
    • this allows for cases where a patient cannot remember exact dates of travel (e.g. I traveled to London, Paris, and Berlin in July and August 2016)
  • free text describing the travel history details and location (Observation.component.valueCodeableConcept.text element)
  • use Observation.component.codeableConcept to record a coded location
  • use Observationcomponent.extension to record a specific address
  • where a more granular address than state is known (e.g. city, street) it is appropriate to use the extension to record an address rather than using the coded location

Represented USCDI+ Data Elements

Use Case Data Class Data Element Name
Case Reporting Travel Information Travel History Dates
Case Reporting Travel Information Travel History Location

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) US Public Health Travel History
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SΣ 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
.... 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:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept Travel (event)
Binding: LOINCCodes (preferred)
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://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 420008001
..... 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
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) Who and/or what the observation is about
... effective[x] SΣ 1..1 (USCDI+) Travel History Dates
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... hasMember SΣ 0..* Reference(US Public Health Transportation Details(2.0.0) | US Public Health Exposure Contact Information(2.0.0)) Related resource that belongs to the Observation group
... Slices for component SΣ 1..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:travelLocation SΣ 1..* BackboneElement (USCDI+) Travel History Location
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:travelHistoryAddress S 0..1 Address Travel history address
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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: LOC
....... display 1..1 string Representation defined by the system
Fixed Value: Location
....... 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Σ 0..1 CodeableConcept Actual component result
...... coding SΣ 0..* Coding Code defined by a terminology system
Binding: PHVS_GeographicLocationHistory_CDC (1) (extensible): Geographical Location History
...... text SΣ 0..1 string Plain text representation of the concept
.... component:travelPurpose SΣ 0..* BackboneElement Purpose of travel
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 280147009
....... 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 CodeableConcept Actual component result
Binding: PHVS_TravelPurpose_FDD (2) (preferred): Travel Purpose

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​value[x].coding Base extensible Geographical location history 📍1 us.cdc.phinvads v0.12
Observation.component:travelPurpose.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​value[x] Base preferred Travel Purpose 📍2 us.cdc.phinvads v0.12

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.implicitRules, Observation.modifierExtension, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.effective[x], Observation.performer, Observation.value[x], Observation.hasMember, Observation.component, Observation.component.modifierExtension, Observation.component.code, Observation.component:travelLocation, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelLocation.code, Observation.component:travelLocation.value[x], Observation.component:travelLocation.value[x].coding, Observation.component:travelLocation.value[x].text, Observation.component:travelPurpose, Observation.component:travelPurpose.modifierExtension, Observation.component:travelPurpose.code, Observation.component:travelPurpose.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.modifierExtension, Observation.component.modifierExtension, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelPurpose.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCoreSimpleObservationProfile(6.1.0) US Public Health Travel History
... category 1..* 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
... code 1..1 CodeableConcept Travel (event)
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://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 420008001
... subject 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) Who and/or what the observation is about
... hasMember S 0..* Reference(US Public Health Transportation Details(2.0.0) | US Public Health Exposure Contact Information(2.0.0)) Related resource that belongs to the Observation group
... Slices for component S 1..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:travelLocation S 1..* BackboneElement (USCDI+) Travel History Location
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:travelHistoryAddress S 0..1 Address Travel history address
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
..... code S 1..1 CodeableConcept Type of component observation (code / type)
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: LOC
....... display 1..1 string Representation defined by the system
Fixed Value: Location
..... value[x] S 0..1 CodeableConcept Actual component result
...... coding S 0..* Coding Code defined by a terminology system
Binding: PHVS_GeographicLocationHistory_CDC (1) (extensible): Geographical Location History
...... text S 0..1 string Plain text representation of the concept
.... component:travelPurpose S 0..* BackboneElement Purpose of travel
..... code S 1..1 CodeableConcept Type of component observation (code / type)
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://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 280147009
..... value[x] S 1..1 CodeableConcept Actual component result
Binding: PHVS_TravelPurpose_FDD (2) (preferred): Travel Purpose

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.component:travelLocation.​value[x].coding Base extensible Geographical location history 📍1 us.cdc.phinvads v0.12
Observation.component:travelPurpose.​value[x] Base preferred Travel Purpose 📍2 us.cdc.phinvads v0.12
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) US Public Health Travel History
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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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.

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:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept Travel (event)
Binding: LOINCCodes (preferred)
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://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 420008001
..... 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
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 (USCDI+) Travel History Dates
.... 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(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) 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 SΣ 0..* Reference(US Public Health Transportation Details(2.0.0) | US Public Health Exposure Contact Information(2.0.0)) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile(6.1.0) | US Core QuestionnaireResponse Profile(6.1.0) | ImagingStudy | Media | MolecularSequence) (USCDI) US Core Profiles or other resource the observation is made from
... Slices for component SΣ 1..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... 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
.... component:travelLocation SΣ 1..* BackboneElement (USCDI+) Travel History Location
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:travelHistoryAddress S 0..1 Address Travel history address
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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: LOC
....... display 1..1 string Representation defined by the system
Fixed Value: Location
....... 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Σ 0..1 CodeableConcept Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding SΣ 0..* Coding Code defined by a terminology system
Binding: PHVS_GeographicLocationHistory_CDC (1) (extensible): Geographical Location History
...... text SΣ 0..1 string Plain text representation of the concept
..... 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
.... component:travelPurpose SΣ 0..* BackboneElement Purpose of travel
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 280147009
....... 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 CodeableConcept Actual component result
Binding: PHVS_TravelPurpose_FDD (2) (preferred): Travel Purpose
..... 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

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​value[x].coding Base extensible Geographical location history 📍1 us.cdc.phinvads v0.12
Observation.component:travelLocation.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​value[x] Base preferred Travel Purpose 📍2 us.cdc.phinvads v0.12
Observation.component:travelPurpose.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.meta, Observation.implicitRules, Observation.language, Observation.text, Observation.extension, Observation.modifierExtension, Observation.identifier, Observation.basedOn, Observation.partOf, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.issued, Observation.performer, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.bodySite, Observation.method, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange, Observation.component:travelLocation, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelLocation.code, Observation.component:travelLocation.value[x], Observation.component:travelLocation.value[x].extension, Observation.component:travelLocation.value[x].coding, Observation.component:travelLocation.value[x].text, Observation.component:travelLocation.dataAbsentReason, Observation.component:travelLocation.interpretation, Observation.component:travelLocation.referenceRange, Observation.component:travelPurpose, Observation.component:travelPurpose.extension, Observation.component:travelPurpose.modifierExtension, Observation.component:travelPurpose.code, Observation.component:travelPurpose.value[x], Observation.component:travelPurpose.dataAbsentReason, Observation.component:travelPurpose.interpretation, Observation.component:travelPurpose.referenceRange All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.extension, Observation.modifierExtension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.component.extension, Observation.component.modifierExtension, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelLocation.value[x].extension, Observation.component:travelPurpose.extension, Observation.component:travelPurpose.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) US Public Health Travel History
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SΣ 1..1 code (USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
.... 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:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept Travel (event)
Binding: LOINCCodes (preferred)
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://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 420008001
..... 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
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) Who and/or what the observation is about
... effective[x] SΣ 1..1 (USCDI+) Travel History Dates
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(US Core Practitioner Profile(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... hasMember SΣ 0..* Reference(US Public Health Transportation Details(2.0.0) | US Public Health Exposure Contact Information(2.0.0)) Related resource that belongs to the Observation group
... Slices for component SΣ 1..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:travelLocation SΣ 1..* BackboneElement (USCDI+) Travel History Location
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:travelHistoryAddress S 0..1 Address Travel history address
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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: LOC
....... display 1..1 string Representation defined by the system
Fixed Value: Location
....... 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Σ 0..1 CodeableConcept Actual component result
...... coding SΣ 0..* Coding Code defined by a terminology system
Binding: PHVS_GeographicLocationHistory_CDC (1) (extensible): Geographical Location History
...... text SΣ 0..1 string Plain text representation of the concept
.... component:travelPurpose SΣ 0..* BackboneElement Purpose of travel
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 280147009
....... 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 CodeableConcept Actual component result
Binding: PHVS_TravelPurpose_FDD (2) (preferred): Travel Purpose

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​value[x].coding Base extensible Geographical location history 📍1 us.cdc.phinvads v0.12
Observation.component:travelPurpose.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​value[x] Base preferred Travel Purpose 📍2 us.cdc.phinvads v0.12

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.implicitRules, Observation.modifierExtension, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.effective[x], Observation.performer, Observation.value[x], Observation.hasMember, Observation.component, Observation.component.modifierExtension, Observation.component.code, Observation.component:travelLocation, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelLocation.code, Observation.component:travelLocation.value[x], Observation.component:travelLocation.value[x].coding, Observation.component:travelLocation.value[x].text, Observation.component:travelPurpose, Observation.component:travelPurpose.modifierExtension, Observation.component:travelPurpose.code, Observation.component:travelPurpose.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.modifierExtension, Observation.component.modifierExtension, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelPurpose.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCoreSimpleObservationProfile(6.1.0) US Public Health Travel History
... category 1..* 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
... code 1..1 CodeableConcept Travel (event)
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://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 420008001
... subject 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) Who and/or what the observation is about
... hasMember S 0..* Reference(US Public Health Transportation Details(2.0.0) | US Public Health Exposure Contact Information(2.0.0)) Related resource that belongs to the Observation group
... Slices for component S 1..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:travelLocation S 1..* BackboneElement (USCDI+) Travel History Location
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:travelHistoryAddress S 0..1 Address Travel history address
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
..... code S 1..1 CodeableConcept Type of component observation (code / type)
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: LOC
....... display 1..1 string Representation defined by the system
Fixed Value: Location
..... value[x] S 0..1 CodeableConcept Actual component result
...... coding S 0..* Coding Code defined by a terminology system
Binding: PHVS_GeographicLocationHistory_CDC (1) (extensible): Geographical Location History
...... text S 0..1 string Plain text representation of the concept
.... component:travelPurpose S 0..* BackboneElement Purpose of travel
..... code S 1..1 CodeableConcept Type of component observation (code / type)
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://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 280147009
..... value[x] S 1..1 CodeableConcept Actual component result
Binding: PHVS_TravelPurpose_FDD (2) (preferred): Travel Purpose

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.component:travelLocation.​value[x].coding Base extensible Geographical location history 📍1 us.cdc.phinvads v0.12
Observation.component:travelPurpose.​value[x] Base preferred Travel Purpose 📍2 us.cdc.phinvads v0.12

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreSimpleObservationProfile(6.1.0) US Public Health Travel History
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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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.

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:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: USCoreSimpleObservationCategory (6.1.0) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SΣ 1..1 CodeableConcept Travel (event)
Binding: LOINCCodes (preferred)
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://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 420008001
..... 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
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 (USCDI+) Travel History Dates
.... 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(6.1.0) | US Core Organization Profile(6.1.0) | US Core Patient Profile(6.1.0) | PractitionerRole | US Core CareTeam Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Who is responsible for the observation
... value[x] SΣC 0..1 (USCDI) Actual result
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean S
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) 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 SΣ 0..* Reference(US Public Health Transportation Details(2.0.0) | US Public Health Exposure Contact Information(2.0.0)) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile(6.1.0) | US Core QuestionnaireResponse Profile(6.1.0) | ImagingStudy | Media | MolecularSequence) (USCDI) US Core Profiles or other resource the observation is made from
... Slices for component SΣ 1..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... 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
.... component:travelLocation SΣ 1..* BackboneElement (USCDI+) Travel History Location
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:travelHistoryAddress S 0..1 Address Travel history address
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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: LOC
....... display 1..1 string Representation defined by the system
Fixed Value: Location
....... 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Σ 0..1 CodeableConcept Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding SΣ 0..* Coding Code defined by a terminology system
Binding: PHVS_GeographicLocationHistory_CDC (1) (extensible): Geographical Location History
...... text SΣ 0..1 string Plain text representation of the concept
..... 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
.... component:travelPurpose SΣ 0..* BackboneElement Purpose of travel
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code SΣ 1..1 CodeableConcept Type of component observation (code / type)
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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 280147009
....... 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 CodeableConcept Actual component result
Binding: PHVS_TravelPurpose_FDD (2) (preferred): Travel Purpose
..... 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

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍6.1.0 US Core v6.1
Observation.code Base preferred LOINC Codes 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​value[x].coding Base extensible Geographical location history 📍1 us.cdc.phinvads v0.12
Observation.component:travelLocation.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:travelLocation.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​value[x] Base preferred Travel Purpose 📍2 us.cdc.phinvads v0.12
Observation.component:travelPurpose.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:travelPurpose.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error Observation.meta, Observation.implicitRules, Observation.language, Observation.text, Observation.extension, Observation.modifierExtension, Observation.identifier, Observation.basedOn, Observation.partOf, Observation.status, Observation.category, Observation.category:us-core, Observation.code, Observation.subject, Observation.focus, Observation.encounter, Observation.effective[x], Observation.issued, Observation.performer, Observation.value[x], Observation.dataAbsentReason, Observation.interpretation, Observation.note, Observation.bodySite, Observation.method, Observation.specimen, Observation.device, Observation.referenceRange, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.referenceRange.low, Observation.referenceRange.high, Observation.referenceRange.type, Observation.referenceRange.appliesTo, Observation.referenceRange.age, Observation.referenceRange.text, Observation.hasMember, Observation.derivedFrom, Observation.component, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code, Observation.component.value[x], Observation.component.dataAbsentReason, Observation.component.interpretation, Observation.component.referenceRange, Observation.component:travelLocation, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelLocation.code, Observation.component:travelLocation.value[x], Observation.component:travelLocation.value[x].extension, Observation.component:travelLocation.value[x].coding, Observation.component:travelLocation.value[x].text, Observation.component:travelLocation.dataAbsentReason, Observation.component:travelLocation.interpretation, Observation.component:travelLocation.referenceRange, Observation.component:travelPurpose, Observation.component:travelPurpose.extension, Observation.component:travelPurpose.modifierExtension, Observation.component:travelPurpose.code, Observation.component:travelPurpose.value[x], Observation.component:travelPurpose.dataAbsentReason, Observation.component:travelPurpose.interpretation, Observation.component:travelPurpose.referenceRange All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Observation.extension, Observation.modifierExtension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.component.extension, Observation.component.modifierExtension, Observation.component:travelLocation.extension, Observation.component:travelLocation.extension:travelHistoryAddress, Observation.component:travelLocation.modifierExtension, Observation.component:travelLocation.value[x].extension, Observation.component:travelPurpose.extension, Observation.component:travelPurpose.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

 

Other representations of profile: CSV, Excel, Schematron