CDC DGMH Report of Ill Traveler
0.1.0 - ci-build
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
| Official URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/ReportOfIllTravelerSimple | Version: 0.1.0 | |||
| Draft as of 2024-03-01 | Computable Name: ReportOfIllTravelerSimple | |||
Simple report of an ill traveler
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
  implicitRules | 0..0 | |||
| contained | 0..0 | |||
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 station-transfer-date | S | 0..1 | date | Date transferred to Q-Station URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date |
| port-health-station | S | 0..1 | CodeableConcept | Name 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 | |
| infectious-disease-name | S | 1..1 | CodeableConcept | Name of Disease URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/disease-name Binding: Infectious Disease VS (required) |
| symptoms | S | 0..* | (Complex) | Symptoms URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/symptom |
| lab-results | 0..* | Reference(US Core Laboratory Result Observation Profile) | Lab Results URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/lab-results | |
| status | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final | |
| category | 0..0 | |||
| subject | 1..1 | Reference(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..1 | string | Human Readable name/title Required Pattern: Simple Report of Ill Traveler | |
| confidentiality | 0..0 | |||
| attester | 0..0 | |||
| custodian | 0..0 | |||
| relatesTo | 0..0 | |||
| event | 0..0 | |||
 section | 0..1 | BackboneElement | Composition is broken into sections | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| station-transfer-date | S | 0..1 | date | Date transferred to Q-Station URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date |
| port-health-station | S | 0..1 | CodeableConcept | Name 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 | |
| infectious-disease-name | S | 1..1 | CodeableConcept | Name of Disease URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/disease-name Binding: Infectious Disease VS (required) |
| symptoms | S | 0..* | (Complex) | Symptoms URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/symptom |
| lab-results | 0..* | Reference(US Core Laboratory Result Observation Profile) | Lab Results URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/lab-results | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final |
 type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
 subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| date | Σ | 1..1 | dateTime | Composition 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..1 | string | Human Readable name/title Required Pattern: Simple Report of Ill Traveler |
 section | C | 0..1 | BackboneElement | Composition 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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If 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-4 | error | Composition | If 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| station-transfer-date | S | 0..1 | date | Date transferred to Q-Station URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date | ||||
| port-health-station | S | 0..1 | CodeableConcept | Name 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 | |||||
| infectious-disease-name | S | 1..1 | CodeableConcept | Name of Disease URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/disease-name Binding: Infectious Disease VS (required) | ||||
| symptoms | S | 0..* | (Complex) | Symptoms URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/symptom | ||||
| lab-results | 0..* | Reference(US Core Laboratory Result Observation Profile) | Lab Results URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/lab-results | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about | ||||
| date | Σ | 1..1 | dateTime | Composition 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..1 | string | Human Readable name/title Required Pattern: Simple Report of Ill Traveler | ||||
| section | C | 0..1 | BackboneElement | Composition 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..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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 0..1 | CodeableConcept | Classification 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..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If 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-4 | error | Composition | If 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Composition
Summary
Mandatory: 3 elements
Must-Support: 4 elements
Prohibited: 9 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| implicitRules | 0..0 | |||
| contained | 0..0 | |||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| station-transfer-date | S | 0..1 | date | Date transferred to Q-Station URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date |
| port-health-station | S | 0..1 | CodeableConcept | Name 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 | |
| infectious-disease-name | S | 1..1 | CodeableConcept | Name of Disease URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/disease-name Binding: Infectious Disease VS (required) |
| symptoms | S | 0..* | (Complex) | Symptoms URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/symptom |
| lab-results | 0..* | Reference(US Core Laboratory Result Observation Profile) | Lab Results URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/lab-results | |
| status | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final | |
| category | 0..0 | |||
| subject | 1..1 | Reference(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..1 | string | Human Readable name/title Required Pattern: Simple Report of Ill Traveler | |
| confidentiality | 0..0 | |||
| attester | 0..0 | |||
| custodian | 0..0 | |||
| relatesTo | 0..0 | |||
| event | 0..0 | |||
| section | 0..1 | BackboneElement | Composition is broken into sections | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| station-transfer-date | S | 0..1 | date | Date transferred to Q-Station URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date |
| port-health-station | S | 0..1 | CodeableConcept | Name 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 | |
| infectious-disease-name | S | 1..1 | CodeableConcept | Name of Disease URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/disease-name Binding: Infectious Disease VS (required) |
| symptoms | S | 0..* | (Complex) | Symptoms URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/symptom |
| lab-results | 0..* | Reference(US Core Laboratory Result Observation Profile) | Lab Results URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/lab-results | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| date | Σ | 1..1 | dateTime | Composition 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..1 | string | Human Readable name/title Required Pattern: Simple Report of Ill Traveler |
| section | C | 0..1 | BackboneElement | Composition 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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If 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-4 | error | Composition | If 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| station-transfer-date | S | 0..1 | date | Date transferred to Q-Station URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/transfer-date | ||||
| port-health-station | S | 0..1 | CodeableConcept | Name 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 | |||||
| infectious-disease-name | S | 1..1 | CodeableConcept | Name of Disease URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/disease-name Binding: Infectious Disease VS (required) | ||||
| symptoms | S | 0..* | (Complex) | Symptoms URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/symptom | ||||
| lab-results | 0..* | Reference(US Core Laboratory Result Observation Profile) | Lab Results URL: http://hl7.org/fhir/us/reportofilltraveler/StructureDefinition/lab-results | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final | ||||
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about | ||||
| date | Σ | 1..1 | dateTime | Composition 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..1 | string | Human Readable name/title Required Pattern: Simple Report of Ill Traveler | ||||
| section | C | 0..1 | BackboneElement | Composition 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..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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 0..1 | CodeableConcept | Classification 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..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If 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-4 | error | Composition | If 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-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Composition
Summary
Mandatory: 3 elements
Must-Support: 4 elements
Prohibited: 9 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 Public Health Working Group. Package hl7.fhir.us.illTraveler#0.1.0 based on FHIR 4.0.1. Generated 2024-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change