CDC DGMH Report of Ill Traveler
0.1.0 - ci-build

CDC DGMH Report of Ill Traveler, published by HL7 Public Health Working Group. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ReportIIITraveler-ig/ and changes regularly. See the Directory of published versions

Resource Profile: ReportOfIllTraveler

Official URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/ReportOfIllTraveler Version: 0.1.0
Draft as of 2024-03-01 Computable Name: ReportOfIllTraveler

Report of an ill traveler

Usage:

Formal Views of Profile Content

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

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... contained 0..0
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... station-transfer-date S0..1dateDate transferred to Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date
... flight-detail 0..*(Complex)Flight Details
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/flight-details
... status 1..1codepreliminary | final | amended | entered-in-error
Required Pattern: final
... type 1..1CodeableConceptKind of composition (LOINC if possible)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55751-2
..... display1..1stringRepresentation defined by the system
Fixed Value: Public health Case report
... subject 1..1Reference(Resource)Who and/or what the composition is about
... encounter 0..0
... Slices for author 1..*Reference(RelatedPerson | Organization)Contact info for the case report
Slice: Unordered, Open by value:code
.... author:stateContact 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:localContact 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:diseaseContact 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title 1..1stringHuman Readable name/title
Required Pattern: Report of Ill Traveler
... confidentiality 0..0
... attester 0..0
... relatesTo 0..1BackboneElementRelationships to other compositions/documents
... event 0..1BackboneElementThe clinical service(s) being documented
... Slices for section 0..1BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:flightItinerary 0..1BackboneElementComposition is broken into sections
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Flight details for the ill Traveler
..... entry 0..*Reference(FlightItinerary)A reference to data that supports this section
.... section:infectiousDisease 0..1BackboneElementComposition is broken into sections
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Information about the Infectious Disease, including labs and x-rays
..... entry 0..*Reference(InfectiousDisease)A reference to data that supports this section

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... station-transfer-date S0..1dateDate transferred to Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date
... flight-detail 0..*(Complex)Flight Details
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/flight-details
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


Required Pattern: final
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55751-2
..... display1..1stringRepresentation defined by the system
Fixed Value: Public health Case report
... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... date Σ1..1dateTimeComposition editing time
... Slices for author Σ1..*Reference(RelatedPerson | Organization)Contact info for the case report
Slice: Unordered, Open by value:code
.... author:stateContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:localContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:diseaseContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
Required Pattern: Report of Ill Traveler
... relatesTo 0..1BackboneElementRelationships to other compositions/documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..1BackboneElementThe clinical service(s) being documented
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... Slices for section C0..1BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... section:flightItinerary C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Flight details for the ill Traveler
..... entry C0..*Reference(FlightItinerary)A reference to data that supports this section
.... section:infectiousDisease C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Information about the Infectious Disease, including labs and x-rays
..... entry C0..*Reference(InfectiousDisease)A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: 55751-2("Public health Case report")
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... station-transfer-date S0..1dateDate transferred to Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date
... port-health-station S0..1CodeableConceptName of Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/port-health-station
Binding: Port Health Stations VS (required)
... flight-detail 0..*(Complex)Flight Details
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/flight-details
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


Required Pattern: final
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


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
..... system0..1uriIdentity of the terminology system
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55751-2
..... display1..1stringRepresentation defined by the system
Fixed Value: Public health Case report
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... category Σ0..*CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... date Σ1..1dateTimeComposition editing time
... Slices for author Σ1..*Reference(RelatedPerson | Organization)Contact info for the case report
Slice: Unordered, Open by value:code
.... author:stateContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:localContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:diseaseContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
Required Pattern: Report of Ill Traveler
... custodian Σ0..1Reference(Organization)Organization which maintains the composition
... relatesTo 0..1BackboneElementRelationships to other compositions/documents
.... 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..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..1BackboneElementThe clinical service(s) being documented
.... 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 Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... Slices for section C0..1BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section: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
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(Resource)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:flightItinerary C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... 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
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Flight details for the ill Traveler
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(FlightItinerary)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:infectiousDisease C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... 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
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Information about the Infectious Disease, including labs and x-rays
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(InfectiousDisease)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: 55751-2("Public health Case report")
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:flightItinerary.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:flightItinerary.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:flightItinerary.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:flightItinerary.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:infectiousDisease.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:infectiousDisease.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:infectiousDisease.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:infectiousDisease.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 1 element
Must-Support: 2 elements
Prohibited: 4 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 Composition.author is sliced based on the value of value:code
  • The element Composition.section is sliced based on the value of value:code

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... contained 0..0
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... station-transfer-date S0..1dateDate transferred to Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date
... flight-detail 0..*(Complex)Flight Details
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/flight-details
... status 1..1codepreliminary | final | amended | entered-in-error
Required Pattern: final
... type 1..1CodeableConceptKind of composition (LOINC if possible)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55751-2
..... display1..1stringRepresentation defined by the system
Fixed Value: Public health Case report
... subject 1..1Reference(Resource)Who and/or what the composition is about
... encounter 0..0
... Slices for author 1..*Reference(RelatedPerson | Organization)Contact info for the case report
Slice: Unordered, Open by value:code
.... author:stateContact 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:localContact 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:diseaseContact 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title 1..1stringHuman Readable name/title
Required Pattern: Report of Ill Traveler
... confidentiality 0..0
... attester 0..0
... relatesTo 0..1BackboneElementRelationships to other compositions/documents
... event 0..1BackboneElementThe clinical service(s) being documented
... Slices for section 0..1BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:flightItinerary 0..1BackboneElementComposition is broken into sections
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Flight details for the ill Traveler
..... entry 0..*Reference(FlightItinerary)A reference to data that supports this section
.... section:infectiousDisease 0..1BackboneElementComposition is broken into sections
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Information about the Infectious Disease, including labs and x-rays
..... entry 0..*Reference(InfectiousDisease)A reference to data that supports this section

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... station-transfer-date S0..1dateDate transferred to Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date
... flight-detail 0..*(Complex)Flight Details
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/flight-details
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


Required Pattern: final
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55751-2
..... display1..1stringRepresentation defined by the system
Fixed Value: Public health Case report
... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... date Σ1..1dateTimeComposition editing time
... Slices for author Σ1..*Reference(RelatedPerson | Organization)Contact info for the case report
Slice: Unordered, Open by value:code
.... author:stateContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:localContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:diseaseContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
Required Pattern: Report of Ill Traveler
... relatesTo 0..1BackboneElementRelationships to other compositions/documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..1BackboneElementThe clinical service(s) being documented
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... Slices for section C0..1BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... section:flightItinerary C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Flight details for the ill Traveler
..... entry C0..*Reference(FlightItinerary)A reference to data that supports this section
.... section:infectiousDisease C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Information about the Infectious Disease, including labs and x-rays
..... entry C0..*Reference(InfectiousDisease)A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: 55751-2("Public health Case report")
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... station-transfer-date S0..1dateDate transferred to Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date
... port-health-station S0..1CodeableConceptName of Q-Station
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/port-health-station
Binding: Port Health Stations VS (required)
... flight-detail 0..*(Complex)Flight Details
URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/flight-details
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


Required Pattern: final
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


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
..... system0..1uriIdentity of the terminology system
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55751-2
..... display1..1stringRepresentation defined by the system
Fixed Value: Public health Case report
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... category Σ0..*CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ1..1Reference(Resource)Who and/or what the composition is about
... date Σ1..1dateTimeComposition editing time
... Slices for author Σ1..*Reference(RelatedPerson | Organization)Contact info for the case report
Slice: Unordered, Open by value:code
.... author:stateContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:localContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
.... author:diseaseContact Σ0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
Required Pattern: Report of Ill Traveler
... custodian Σ0..1Reference(Organization)Organization which maintains the composition
... relatesTo 0..1BackboneElementRelationships to other compositions/documents
.... 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..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..1BackboneElementThe clinical service(s) being documented
.... 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 Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... Slices for section C0..1BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section: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
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(Resource)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:flightItinerary C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... 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
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Flight details for the ill Traveler
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(FlightItinerary)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:infectiousDisease C0..1BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... 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
..... title 0..1stringLabel for section (e.g. for ToC)
Required Pattern: Information about the Infectious Disease, including labs and x-rays
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

..... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

..... entry C0..*Reference(InfectiousDisease)A reference to data that supports this section
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: 55751-2("Public health Case report")
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:flightItinerary.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:flightItinerary.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:flightItinerary.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:flightItinerary.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:infectiousDisease.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:infectiousDisease.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:infectiousDisease.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:infectiousDisease.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:flightItinerary, Composition.section:infectiousDiseaseA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 1 element
Must-Support: 2 elements
Prohibited: 4 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 Composition.author is sliced based on the value of value:code
  • The element Composition.section is sliced based on the value of value:code

 

Other representations of profile: CSV, Excel, Schematron