HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2 United States of America flag

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Travel History

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-travel-history Version: 2.1.0
Active as of 2022-08-31 Computable Name: USPublicHealthTravelHistory

This Observation profile represents a patient’s travel history.

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 accurately 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

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the value of value:code

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationUS Public Health Travel History
... code S1..1CodeableConceptType of observation (code / type)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 420008001
... subject S1..1Reference(US Public Health Patient)Who and/or what the observation is about
... effective[x] S1..1dateTime, Period, Timing, instantDate or period of time spent in the location
... Slices for component S1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:travelLocation S1..*BackboneElementTravel location
..... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... travelHistoryAddress S0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LOC
....... display1..1stringRepresentation defined by the system
Fixed Value: Location
..... value[x] S0..1CodeableConceptActual component result
...... coding S0..*CodingCode defined by a terminology system
Binding: Geographical location history (extensible): Geographical Location History


Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
...... text S0..1stringPlain text representation of the concept
Example for text: Spent 8 years in the UK during the BSE outbreak
.... component:travelPurpose S0..*BackboneElementPurpose of travel
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 280147009
..... value[x] S1..1CodeableConceptActual component result
Binding: Travel Purpose (CDC) (preferred): Travel Purpose


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Public Health Travel History
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

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


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


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 420008001
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Public Health Patient)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣ1..1Date or period of time spent in the location
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(US Public Health Transportation Details | US Public Health Exposure Contact Information)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SΣ1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

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

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


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:travelLocation SΣ1..*BackboneElementTravel location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... travelHistoryAddress S0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LOC
....... display1..1stringRepresentation defined by the system
Fixed Value: Location
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ0..1CodeableConceptActual component result
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ0..*CodingCode defined by a terminology system
Binding: Geographical location history (extensible): Geographical Location History



Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
...... text SΣ0..1stringPlain text representation of the concept
Example for text: Spent 8 years in the UK during the BSE outbreak
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 280147009
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1CodeableConceptActual component result
Binding: Travel Purpose (CDC) (preferred): Travel Purpose

..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Public Health Travel History
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 420008001
... subject Σ1..1Reference(US Public Health Patient)Who and/or what the observation is about
... effective[x] Σ1..1Date or period of time spent in the location
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... Slices for component Σ1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:travelLocation Σ1..*BackboneElementTravel location
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... travelHistoryAddress 0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LOC
....... display1..1stringRepresentation defined by the system
Fixed Value: Location
..... value[x] Σ0..1CodeableConceptActual component result
...... coding Σ0..*CodingCode defined by a terminology system
Binding: Geographical location history (extensible): Geographical Location History


...... text Σ0..1stringPlain text representation of the concept
.... component:travelPurpose Σ0..*BackboneElementPurpose of travel
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 280147009
..... value[x] Σ1..1CodeableConceptActual component result
Binding: Travel Purpose (CDC) (preferred): Travel Purpose


doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the value of value:code

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationUS Public Health Travel History
... code S1..1CodeableConceptType of observation (code / type)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 420008001
... subject S1..1Reference(US Public Health Patient)Who and/or what the observation is about
... effective[x] S1..1dateTime, Period, Timing, instantDate or period of time spent in the location
... Slices for component S1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:travelLocation S1..*BackboneElementTravel location
..... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... travelHistoryAddress S0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LOC
....... display1..1stringRepresentation defined by the system
Fixed Value: Location
..... value[x] S0..1CodeableConceptActual component result
...... coding S0..*CodingCode defined by a terminology system
Binding: Geographical location history (extensible): Geographical Location History


Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
...... text S0..1stringPlain text representation of the concept
Example for text: Spent 8 years in the UK during the BSE outbreak
.... component:travelPurpose S0..*BackboneElementPurpose of travel
..... code S1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 280147009
..... value[x] S1..1CodeableConceptActual component result
Binding: Travel Purpose (CDC) (preferred): Travel Purpose


doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Public Health Travel History
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

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


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


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 420008001
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Public Health Patient)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣ1..1Date or period of time spent in the location
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(US Public Health Transportation Details | US Public Health Exposure Contact Information)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component SΣ1..*BackboneElementComponent results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

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

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


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result
.... component:travelLocation SΣ1..*BackboneElementTravel location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... travelHistoryAddress S0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LOC
....... display1..1stringRepresentation defined by the system
Fixed Value: Location
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ0..1CodeableConceptActual component result
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ0..*CodingCode defined by a terminology system
Binding: Geographical location history (extensible): Geographical Location History



Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
...... text SΣ0..1stringPlain text representation of the concept
Example for text: Spent 8 years in the UK during the BSE outbreak
..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 280147009
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] SΣ1..1CodeableConceptActual component result
Binding: Travel Purpose (CDC) (preferred): Travel Purpose

..... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexamplePattern: SNOMED CT code 420008001
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:travelLocation.codeexamplePattern: LOC("Location")
Observation.component:travelLocation.value[x].codingextensiblePHVS_GeographicLocationHistory_CDC
Observation.component:travelLocation.dataAbsentReasonextensibleDataAbsentReason
Observation.component:travelLocation.interpretationextensibleObservationInterpretationCodes
Observation.component:travelPurpose.codeexamplePattern: SNOMED CT code 280147009
Observation.component:travelPurpose.value[x]preferredPHVS_TravelPurpose_CDC
Observation.component:travelPurpose.dataAbsentReasonextensibleDataAbsentReason
Observation.component:travelPurpose.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePathDetailsRequirements
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()
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()
ele-1errorObservation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.deviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
ele-1errorObservation.referenceRange.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.referenceRange.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.referenceRange.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.referenceRange.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.referenceRange.lowAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.highAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.referenceRange.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.hasMemberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.derivedFromAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.componentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:travelLocation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:travelLocation.extension:travelHistoryAddressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:travelLocation.extension:travelHistoryAddressMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:travelLocation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:travelLocation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:travelLocation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocation.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocation.value[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:travelLocation.value[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:travelLocation.value[x].codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocation.value[x].textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelLocation.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelPurposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelPurpose.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:travelPurpose.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:travelPurpose.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorObservation.component:travelPurpose.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorObservation.component:travelPurpose.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelPurpose.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelPurpose.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelPurpose.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorObservation.component:travelPurpose.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())