HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm CI Build

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.30 StructureDefinition-travel-history-observation

This Observation profile represents the following for eCR:

  • the Initial Case Report subject’s travel history as a string, an address, or a coded location
  • Observation.effectiveTime contains the date or period of time spent in the location
  • it is possible to have multiple Observation.components, each containing a different location, 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). However, most uses will involve a single component (location)
  • free text describing the travel history details and location can be entered using the Observation.component.valueCodeableConcept.text element
  • use component.codeableConcept to record a coded location
  • use component.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.

SD.30.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-observation

Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on Observation

Summary

Mandatory: 1 element
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S0..*ObservationeICR Travel History
... code S1..1CodeableConceptRequired 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
... effective[x] S0..1dateTime, Period, Timing, instantDate or period of time spent in the location
... component S1..*BackboneElement
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... travel-history-address-extension 0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension
.... code S1..1CodeableConceptRequired 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..1CodeableConcept
..... coding S0..*CodingBinding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.114222.4.11.3201 (extensible)
Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
..... text S0..1stringExample for text: Spent 8 years in the UK during the BSE outbreak

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SI0..*ObservationeICR Travel History
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
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 ΣI0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI0..1Date or period of time spent in the location
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*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)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device I0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣI1..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... travel-history-address-extension I0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
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] ΣI0..1CodeableConceptActual component result
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.114222.4.11.3201 (extensible)

Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
..... text SΣI0..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)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

Summary

Mandatory: 1 element
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S0..*ObservationeICR Travel History
... code S1..1CodeableConceptRequired 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
... effective[x] S0..1dateTime, Period, Timing, instantDate or period of time spent in the location
... component S1..*BackboneElement
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... travel-history-address-extension 0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension
.... code S1..1CodeableConceptRequired 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..1CodeableConcept
..... coding S0..*CodingBinding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.114222.4.11.3201 (extensible)
Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
..... text S0..1stringExample for text: Spent 8 years in the UK during the BSE outbreak

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SI0..*ObservationeICR Travel History
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for observation
... basedOn ΣI0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category I0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred)
... code SΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
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 ΣI0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣI0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣI0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI0..1Date or period of time spent in the location
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣI0..1instantDate/Time this version was made available
... performer ΣI0..*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)
... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
... note I0..*AnnotationComments about the observation
... bodySite I0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... method I0..1CodeableConceptHow it was done
Binding: ObservationMethods (example)
... specimen I0..1Reference(Specimen)Specimen used for this observation
... device I0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type I0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred)
.... appliesTo I0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... age I0..1RangeApplicable age range, if relevant
.... text I0..1stringText based reference range in an observation
... hasMember ΣI0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣI0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component SΣI1..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... travel-history-address-extension I0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣI1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example)
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] ΣI0..1CodeableConceptActual component result
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.114222.4.11.3201 (extensible)

Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"}
..... text SΣI0..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)
.... interpretation I0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible)
.... referenceRange I0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron