electronic Case Reporting (eCR) Implementation Guide: STU2 Ballot

This page is part of the electronic Case Reporting (eCR) (v0.2.0: STU 1 Ballot 2) based on FHIR R3. 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.25 StructureDefinition-eicr-travel-history

eCR Profile: eicr-travel-history

Scope and Usage

The Electronic Case Reporting Travel History profile establishes the core elements, extensions, vocabularies and value sets for representing the following for electronic case reporting:

  • 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

Additional Profile specific implementation guidance:

  • none

Examples

SD.25.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/eicr-travel-history

Published on Wed Aug 01 00:00:00 AEST 2018 as a draft by .

This profile builds on Observation

Summary

Mandatory: 1 element
Must-Support: 7 elements

Extensions

This structure refers to these extensions:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S0..*eICR Travel History
... code S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://snomed.info/sct","code":"420008001"}]}
... effective[x] S0..1dateTime, PeriodDate or period of time spent in the location
... component S1..*BackboneElement
.... code S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://hl7.org/fhir/v3/ParticipationType","code":"LOC","display":"Location"}]}
.... valueCodeableConcept S0..1CodeableConceptBinding: Geographical location history (extensible)
Example General': {"coding":[{"system":"urn:oid:1.0.3166.1","code":"FJI","display":"Fiji"}]}
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... extension-eicr-travel-history-address 0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-eicr-travel-history-address
..... coding S0..*Coding
..... text S0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SI0..*eICR Travel History
... id Σ0..1idLogical 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: Common Languages (extensible)
... text I0..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 | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINC Codes (example)
Required Pattern: {"coding":[{"system":"http://snomed.info/sct","code":"420008001"}]}
... subject Σ0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] SΣ0..1dateTime, PeriodDate or period of time spent in the location
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣI0..1Quantity, CodeableConcept, string, boolean, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual result
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible)
.... appliesTo 0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related ΣI0..*BackboneElementResource related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse | Sequence)Resource that is related to this one
... component SΣI1..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v3/ParticipationType","code":"LOC","display":"Location"}]}
.... valueCodeableConcept SΣ0..1CodeableConceptActual component result
Binding: Geographical location history (extensible)
Example General': {"coding":[{"system":"urn:oid:1.0.3166.1","code":"FJI","display":"Fiji"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension-eicr-travel-history-address 0..1AddressTravel history address
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-eicr-travel-history-address
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-eicr-travel-history-address"
...... valueAddress 0..1AddressValue of extension
Example General': {"city":"Nadi","country":"Fiji"}
..... coding SΣ0..*CodingCode defined by a terminology system
..... text SΣ0..1stringPlain text representation of the concept
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

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