US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-travel-history | Version: 1.0.0 | |||
Active as of 2023-10-04 | Computable Name: USPublicHealthTravelHistory |
This Observation profile represents a patient’s travel history.
The following data for a patient can be recorded:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
code | S | 1..1 | CodeableConcept | Type of 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: 420008001 | |
subject | S | 1..1 | Reference(US Public Health Patient) | Who and/or what the observation is about |
effective[x] | S | 1..1 | dateTime, Period, Timing, instant | Date or period of time spent in the location |
hasMember | S | 0..* | Reference(US Public Health Transportation Details | US Public Health Exposure Contact Information) | 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 | Travel location |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
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: Geographical location history (extensible): Geographical Location History Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"} |
text | S | 0..1 | string | Plain text representation of the concept Example for text: Spent 8 years in the UK during the BSE outbreak |
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: Travel Purpose (preferred): Travel Purpose |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.component:travelLocation.value[x].coding | extensible | PHVS_GeographicLocationHistory_CDC |
Observation.component:travelPurpose.value[x] | preferred | PHVS_TravelPurpose_FDD |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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 | SΣ | 1..1 | Reference(US Public Health Patient) | Who and/or what the observation is about |
effective[x] | SΣ | 1..1 | Date or period of time spent in the location | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
hasMember | SΣ | 0..* | Reference(US Public Health Transportation Details | US Public Health Exposure Contact Information) | 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 |
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
component:travelLocation | SΣ | 1..* | BackboneElement | Travel location |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
travelHistoryAddress | S | 0..1 | Address | Travel history address URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 |
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: Geographical location history (extensible): Geographical Location History Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"} |
text | SΣ | 0..1 | string | Plain text representation of the concept Example for text: Spent 8 years in the UK during the BSE outbreak |
component:travelPurpose | SΣ | 0..* | BackboneElement | Purpose of travel |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 |
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: Travel Purpose (preferred): Travel Purpose |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.status | required | ObservationStatus |
Observation.code | example | Pattern: SNOMED CT code 420008001 |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:travelLocation.code | example | Pattern: LOC("Location") |
Observation.component:travelLocation.value[x].coding | extensible | PHVS_GeographicLocationHistory_CDC |
Observation.component:travelPurpose.code | example | Pattern: SNOMED CT code 280147009 |
Observation.component:travelPurpose.value[x] | preferred | PHVS_TravelPurpose_FDD |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
code | SΣ | 1..1 | CodeableConcept | Type of 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: 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) | Who and/or what the observation is about | ||||
focus | ΣTU | 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 | Date or period of time spent in the location | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
value[x] | ΣC | 0..1 | Actual 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 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
age | 0..1 | Range | Applicable age range, if relevant | |||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | 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..* | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Travel location | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
travelHistoryAddress | S | 0..1 | Address | Travel history address URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
coding | SΣ | 0..* | Coding | Code 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..1 | string | Plain text representation of the concept Example for text: Spent 8 years in the UK during the BSE outbreak | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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: Travel Purpose (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 | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.code | example | Pattern: SNOMED CT code 420008001 | ||||
Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
Observation.method | example | ObservationMethods | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:travelLocation.code | example | Pattern: LOC("Location") | ||||
Observation.component:travelLocation.value[x].coding | extensible | PHVS_GeographicLocationHistory_CDC | ||||
Observation.component:travelLocation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:travelLocation.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:travelPurpose.code | example | Pattern: SNOMED CT code 280147009 | ||||
Observation.component:travelPurpose.value[x] | preferred | PHVS_TravelPurpose_FDD | ||||
Observation.component:travelPurpose.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:travelPurpose.interpretation | extensible | ObservationInterpretationCodes |
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:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
code | S | 1..1 | CodeableConcept | Type of 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: 420008001 | |
subject | S | 1..1 | Reference(US Public Health Patient) | Who and/or what the observation is about |
effective[x] | S | 1..1 | dateTime, Period, Timing, instant | Date or period of time spent in the location |
hasMember | S | 0..* | Reference(US Public Health Transportation Details | US Public Health Exposure Contact Information) | 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 | Travel location |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
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: Geographical location history (extensible): Geographical Location History Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"} |
text | S | 0..1 | string | Plain text representation of the concept Example for text: Spent 8 years in the UK during the BSE outbreak |
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: Travel Purpose (preferred): Travel Purpose |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.component:travelLocation.value[x].coding | extensible | PHVS_GeographicLocationHistory_CDC |
Observation.component:travelPurpose.value[x] | preferred | PHVS_TravelPurpose_FDD |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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 | SΣ | 1..1 | Reference(US Public Health Patient) | Who and/or what the observation is about |
effective[x] | SΣ | 1..1 | Date or period of time spent in the location | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
hasMember | SΣ | 0..* | Reference(US Public Health Transportation Details | US Public Health Exposure Contact Information) | 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 |
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
component:travelLocation | SΣ | 1..* | BackboneElement | Travel location |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
travelHistoryAddress | S | 0..1 | Address | Travel history address URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 |
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: Geographical location history (extensible): Geographical Location History Example for coding: {"system":"urn:iso:std:iso:3166","code":"FJI","display":"Fiji"} |
text | SΣ | 0..1 | string | Plain text representation of the concept Example for text: Spent 8 years in the UK during the BSE outbreak |
component:travelPurpose | SΣ | 0..* | BackboneElement | Purpose of travel |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 |
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: Travel Purpose (preferred): Travel Purpose |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.status | required | ObservationStatus |
Observation.code | example | Pattern: SNOMED CT code 420008001 |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:travelLocation.code | example | Pattern: LOC("Location") |
Observation.component:travelLocation.value[x].coding | extensible | PHVS_GeographicLocationHistory_CDC |
Observation.component:travelPurpose.code | example | Pattern: SNOMED CT code 280147009 |
Observation.component:travelPurpose.value[x] | preferred | PHVS_TravelPurpose_FDD |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
code | SΣ | 1..1 | CodeableConcept | Type of 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: 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) | Who and/or what the observation is about | ||||
focus | ΣTU | 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 | Date or period of time spent in the location | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
value[x] | ΣC | 0..1 | Actual 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 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
age | 0..1 | Range | Applicable age range, if relevant | |||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | 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..* | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | Travel location | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
travelHistoryAddress | S | 0..1 | Address | Travel history address URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-address-extension | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
coding | SΣ | 0..* | Coding | Code 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..1 | string | Plain text representation of the concept Example for text: Spent 8 years in the UK during the BSE outbreak | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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: Travel Purpose (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 | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.code | example | Pattern: SNOMED CT code 420008001 | ||||
Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
Observation.method | example | ObservationMethods | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:travelLocation.code | example | Pattern: LOC("Location") | ||||
Observation.component:travelLocation.value[x].coding | extensible | PHVS_GeographicLocationHistory_CDC | ||||
Observation.component:travelLocation.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:travelLocation.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:travelPurpose.code | example | Pattern: SNOMED CT code 280147009 | ||||
Observation.component:travelPurpose.value[x] | preferred | PHVS_TravelPurpose_FDD | ||||
Observation.component:travelPurpose.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:travelPurpose.interpretation | extensible | ObservationInterpretationCodes |
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:
Other representations of profile: CSV, Excel, Schematron