HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.1 - STU 2.1.1
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.1 - STU 2.1.1
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition | Version: 2.1.1 | |||
| Active as of 2023-12-14 | Computable Name: RRComposition | |||
This Composition profile represents the Reportability Response that is created in response to an electronic Initial Case Report Composition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USPublicHealthComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | S | 0..* | USPublicHealthComposition | Reportability Response Composition |
  sliceExtensionInformationRecipient | 1..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Reportability Response recipient(s) URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension | |
  type | S | 1..1 | CodeableConcept | Public Health Reportability Response Document 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://loinc.org | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
 subject | S | 1..1 | Reference(US Public Health Patient) | Patient |
| encounter | S | 1..1 | Reference(eICR Encounter) | eICR Encounter |
| author | S | 1..* | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
| custodian | 1..1 | Reference(US Public Health Organization) | Organization which maintains the composition | |
 Slices for relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
 relatesTo:sliceTransformed | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | |
  code | 1..1 | code | replaces | transforms | signs | appends Fixed Value: transforms | |
  target[x] | 1..1 | Identifier | Identifier of the Document or Composition transformed | |
 relatesTo:sliceReplaced | 0..1 | BackboneElement | Document or Composition that this Composition replaces | |
| code | 1..1 | code | replaces | transforms | signs | appends Fixed Value: replaces | |
| target[x] | 1..1 | Identifier, Reference(Composition) | Identifier/Reference to the Document or Composition transformed | |
| Slices for section | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code | |
| section:sliceRRSubjectSection | S | 0..1 | BackboneElement | Reportability Response Subject Section |
 code | S | 1..1 | CodeableConcept | Reportable condition response information and summary Document 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88084-9 | |
| text | S | 1..1 | Narrative | Reportability Response Subject Section |
| section:sliceEICRSection | S | 1..1 | BackboneElement | Electronic Initial Case Report Section |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionEICRProcessingStatus | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
| extensionAlternatelyManuallyInitiatedEICR | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): Initiation Types |
| extensionEICRReceiptTime | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
| code | S | 1..1 | CodeableConcept | Initial case report processing information Document 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88082-3 | |
 Slices for entry | S | 0..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:sliceEICRDocument | S | 0..* | Reference(eICR Document Bundle | US Core DocumentReference Profile) | Reference to eICR Document Bundle or eICR CDA document |
| identifier | 0..1 | Identifier | eICR Document Bundle identifier | |
| display | S | 0..1 | string | Filename of eICR |
| section:sliceRRSummarySection | S | 0..1 | BackboneElement | Reportability Response Summary Section |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionRRPriority | S | 1..1 | CodeableConcept | RR Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority |
| code | S | 1..1 | CodeableConcept | Document summary 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 55112-7 | |
| text | S | 1..1 | Narrative | RR Summary Section narrative |
| Slices for entry | S | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
 entry:sliceRRSummary | S | 1..1 | Reference(RR Summary) | RR Summary |
 entry:sliceRRCondition | S | 1..* | Reference(RR Relevant Reportable Condition Observation) | Relevant Reportable Condition |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | S | 0..* | USPublicHealthComposition | Reportability Response Composition |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sliceExtensionVersionNumber | S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
| sliceExtensionInformationRecipient | S | 1..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Reportability Response recipient(s) URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..1 | Identifier | Public Health Composition identifier |
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type | SΣ | 1..1 | CodeableConcept | Public Health Reportability Response Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
| subject | SΣ | 1..1 | Reference(US Public Health Patient) | Patient |
| encounter | SΣ | 1..1 | Reference(eICR Encounter) | eICR Encounter |
| date | SΣ | 1..1 | dateTime | Composition editing time |
| author | SΣ | 1..* | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
| title | SΣ | 1..1 | string | Human Readable name/title |
| custodian | SΣ | 1..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
| Slices for relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
| relatesTo:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
 target[x] | 1..1 | Target of the relationship | ||
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| relatesTo:sliceTransformed | S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms |
| target[x] | S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
| relatesTo:sliceReplaced | S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces |
| target[x] | S | 1..1 | Identifier/Reference to the Document or Composition transformed | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code |
| section:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:sliceRRSubjectSection | SC | 0..1 | BackboneElement | Reportability Response Subject Section |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Reportable condition response information and summary Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88084-9 | |
| text | SC | 1..1 | Narrative | Reportability Response Subject Section |
| section:sliceEICRSection | SC | 1..1 | BackboneElement | Electronic Initial Case Report Section |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionEICRProcessingStatus | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
| extensionAlternatelyManuallyInitiatedEICR | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): Initiation Types |
| extensionEICRReceiptTime | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Initial case report processing information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88082-3 | |
| Slices for entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:sliceEICRDocument | SC | 0..* | Reference(eICR Document Bundle | US Core DocumentReference Profile) | Reference to eICR Document Bundle or eICR CDA document |
| identifier | Σ | 0..1 | Identifier | eICR Document Bundle identifier |
| display | SΣ | 0..1 | string | Filename of eICR |
| section:sliceRRSummarySection | SC | 0..1 | BackboneElement | Reportability Response Summary Section |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionRRPriority | S | 1..1 | CodeableConcept | RR Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Document summary Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 55112-7 | |
| text | SC | 1..1 | Narrative | RR Summary Section narrative |
| Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:sliceRRSummary | SC | 1..1 | Reference(RR Summary) | RR Summary |
| entry:sliceRRCondition | SC | 1..* | Reference(RR Relevant Reportable Condition Observation) | Relevant Reportable Condition |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | Pattern: LOINC code 88085-6 |
| Composition.relatesTo.code | required | DocumentRelationshipType |
| Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transforms |
| Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaces |
| Composition.section:sliceRRSubjectSection.code | example | Pattern: LOINC code 88084-9 |
| Composition.section:sliceEICRSection.code | example | Pattern: LOINC code 88082-3 |
| Composition.section:sliceRRSummarySection.code | example | Pattern: LOINC code 55112-7 |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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 | S | 0..* | USPublicHealthComposition | Reportability Response Composition | ||||
| 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 | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sliceExtensionVersionNumber | S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber | ||||
| sliceExtensionInformationRecipient | S | 1..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Reportability Response recipient(s) URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 1..1 | Identifier | Public Health Composition identifier | ||||
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | SΣ | 1..1 | CodeableConcept | Public Health Reportability Response Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |||||
| 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 | |||||
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject | SΣ | 1..1 | Reference(US Public Health Patient) | Patient | ||||
| encounter | SΣ | 1..1 | Reference(eICR Encounter) | eICR Encounter | ||||
| date | SΣ | 1..1 | dateTime | Composition editing time | ||||
| author | SΣ | 1..* | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author | ||||
| title | SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| 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 | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian | SΣ | 1..1 | Reference(US Public Health Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code | ||||
| relatesTo: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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target[x] | 1..1 | Target of the relationship | ||||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(Composition) | |||||||
| relatesTo:sliceTransformed | S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | ||||
| 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms | ||||
| target[x] | S | 1..1 | Identifier | Identifier of the Document or Composition transformed | ||||
| relatesTo:sliceReplaced | S | 0..1 | BackboneElement | Document or Composition that this Composition replaces | ||||
| 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces | ||||
| target[x] | S | 1..1 | Identifier/Reference to the Document or Composition transformed | |||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(Composition) | |||||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| 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 | Σ | 0..* | CodeableConcept | Code(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..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code | ||||
| section: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 | ||||
| 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 | ||||
| section:sliceRRSubjectSection | SC | 0..1 | BackboneElement | Reportability Response Subject Section | ||||
| 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 | S | 1..1 | CodeableConcept | Reportable condition response information and summary Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88084-9 | |||||
| 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 | |||||
| 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 | SC | 1..1 | Narrative | Reportability Response Subject Section | ||||
| 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 | ||||
| section:sliceEICRSection | SC | 1..1 | BackboneElement | Electronic Initial Case Report Section | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extensionEICRProcessingStatus | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension | ||||
| extensionAlternatelyManuallyInitiatedEICR | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): Initiation Types | ||||
| extensionEICRReceiptTime | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | S | 1..1 | CodeableConcept | Initial case report processing information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88082-3 | |||||
| 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 | |||||
| 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. | |||||
| Slices for entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() | ||||
| entry:sliceEICRDocument | SC | 0..* | Reference(eICR Document Bundle | US Core DocumentReference Profile) | Reference to eICR Document Bundle or eICR CDA document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | eICR Document Bundle identifier | ||||
| display | SΣ | 0..1 | string | Filename of eICR | ||||
| 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 | ||||
| section:sliceRRSummarySection | SC | 0..1 | BackboneElement | Reportability Response Summary Section | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extensionRRPriority | S | 1..1 | CodeableConcept | RR Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | S | 1..1 | CodeableConcept | Document summary Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 55112-7 | |||||
| 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 | |||||
| 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 | SC | 1..1 | Narrative | RR Summary Section narrative | ||||
| 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. | |||||
| Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() | ||||
| entry:sliceRRSummary | SC | 1..1 | Reference(RR Summary) | RR Summary | ||||
| entry:sliceRRCondition | SC | 1..* | Reference(RR Relevant Reportable Condition Observation) | Relevant Reportable Condition | ||||
| 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 | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | Pattern: LOINC code 88085-6 | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transforms | ||||
| Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaces | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:sliceRRSubjectSection.code | example | Pattern: LOINC code 88084-9 | ||||
| Composition.section:sliceRRSubjectSection.mode | required | ListMode | ||||
| Composition.section:sliceRRSubjectSection.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:sliceRRSubjectSection.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:sliceEICRSection.code | example | Pattern: LOINC code 88082-3 | ||||
| Composition.section:sliceEICRSection.mode | required | ListMode | ||||
| Composition.section:sliceEICRSection.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:sliceEICRSection.entry:sliceEICRDocument.type | extensible | ResourceType | ||||
| Composition.section:sliceEICRSection.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:sliceRRSummarySection.code | example | Pattern: LOINC code 55112-7 | ||||
| Composition.section:sliceRRSummarySection.mode | required | ListMode | ||||
| Composition.section:sliceRRSummarySection.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:sliceRRSummarySection.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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 USPublicHealthComposition
Summary
Mandatory: 7 elements (8 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 2 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 USPublicHealthComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | S | 0..* | USPublicHealthComposition | Reportability Response Composition |
| sliceExtensionInformationRecipient | 1..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Reportability Response recipient(s) URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension | |
| type | S | 1..1 | CodeableConcept | Public Health Reportability Response Document 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
| subject | S | 1..1 | Reference(US Public Health Patient) | Patient |
| encounter | S | 1..1 | Reference(eICR Encounter) | eICR Encounter |
| author | S | 1..* | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
| custodian | 1..1 | Reference(US Public Health Organization) | Organization which maintains the composition | |
| Slices for relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
| relatesTo:sliceTransformed | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | |
| code | 1..1 | code | replaces | transforms | signs | appends Fixed Value: transforms | |
| target[x] | 1..1 | Identifier | Identifier of the Document or Composition transformed | |
| relatesTo:sliceReplaced | 0..1 | BackboneElement | Document or Composition that this Composition replaces | |
| code | 1..1 | code | replaces | transforms | signs | appends Fixed Value: replaces | |
| target[x] | 1..1 | Identifier, Reference(Composition) | Identifier/Reference to the Document or Composition transformed | |
| Slices for section | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code | |
| section:sliceRRSubjectSection | S | 0..1 | BackboneElement | Reportability Response Subject Section |
| code | S | 1..1 | CodeableConcept | Reportable condition response information and summary Document 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88084-9 | |
| text | S | 1..1 | Narrative | Reportability Response Subject Section |
| section:sliceEICRSection | S | 1..1 | BackboneElement | Electronic Initial Case Report Section |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionEICRProcessingStatus | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
| extensionAlternatelyManuallyInitiatedEICR | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): Initiation Types |
| extensionEICRReceiptTime | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
| code | S | 1..1 | CodeableConcept | Initial case report processing information Document 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88082-3 | |
| Slices for entry | S | 0..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:sliceEICRDocument | S | 0..* | Reference(eICR Document Bundle | US Core DocumentReference Profile) | Reference to eICR Document Bundle or eICR CDA document |
| identifier | 0..1 | Identifier | eICR Document Bundle identifier | |
| display | S | 0..1 | string | Filename of eICR |
| section:sliceRRSummarySection | S | 0..1 | BackboneElement | Reportability Response Summary Section |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionRRPriority | S | 1..1 | CodeableConcept | RR Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority |
| code | S | 1..1 | CodeableConcept | Document summary 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 55112-7 | |
| text | S | 1..1 | Narrative | RR Summary Section narrative |
| Slices for entry | S | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:sliceRRSummary | S | 1..1 | Reference(RR Summary) | RR Summary |
| entry:sliceRRCondition | S | 1..* | Reference(RR Relevant Reportable Condition Observation) | Relevant Reportable Condition |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | S | 0..* | USPublicHealthComposition | Reportability Response Composition |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sliceExtensionVersionNumber | S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
| sliceExtensionInformationRecipient | S | 1..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Reportability Response recipient(s) URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..1 | Identifier | Public Health Composition identifier |
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type | SΣ | 1..1 | CodeableConcept | Public Health Reportability Response Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |
| subject | SΣ | 1..1 | Reference(US Public Health Patient) | Patient |
| encounter | SΣ | 1..1 | Reference(eICR Encounter) | eICR Encounter |
| date | SΣ | 1..1 | dateTime | Composition editing time |
| author | SΣ | 1..* | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author |
| title | SΣ | 1..1 | string | Human Readable name/title |
| custodian | SΣ | 1..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
| Slices for relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
| relatesTo:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
| target[x] | 1..1 | Target of the relationship | ||
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| relatesTo:sliceTransformed | S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms |
| target[x] | S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
| relatesTo:sliceReplaced | S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces |
| target[x] | S | 1..1 | Identifier/Reference to the Document or Composition transformed | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code |
| section:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:sliceRRSubjectSection | SC | 0..1 | BackboneElement | Reportability Response Subject Section |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Reportable condition response information and summary Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88084-9 | |
| text | SC | 1..1 | Narrative | Reportability Response Subject Section |
| section:sliceEICRSection | SC | 1..1 | BackboneElement | Electronic Initial Case Report Section |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionEICRProcessingStatus | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension |
| extensionAlternatelyManuallyInitiatedEICR | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): Initiation Types |
| extensionEICRReceiptTime | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Initial case report processing information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88082-3 | |
| Slices for entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:sliceEICRDocument | SC | 0..* | Reference(eICR Document Bundle | US Core DocumentReference Profile) | Reference to eICR Document Bundle or eICR CDA document |
| identifier | Σ | 0..1 | Identifier | eICR Document Bundle identifier |
| display | SΣ | 0..1 | string | Filename of eICR |
| section:sliceRRSummarySection | SC | 0..1 | BackboneElement | Reportability Response Summary Section |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extensionRRPriority | S | 1..1 | CodeableConcept | RR Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Document summary Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 55112-7 | |
| text | SC | 1..1 | Narrative | RR Summary Section narrative |
| Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:sliceRRSummary | SC | 1..1 | Reference(RR Summary) | RR Summary |
| entry:sliceRRCondition | SC | 1..* | Reference(RR Relevant Reportable Condition Observation) | Relevant Reportable Condition |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | Pattern: LOINC code 88085-6 |
| Composition.relatesTo.code | required | DocumentRelationshipType |
| Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transforms |
| Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaces |
| Composition.section:sliceRRSubjectSection.code | example | Pattern: LOINC code 88084-9 |
| Composition.section:sliceEICRSection.code | example | Pattern: LOINC code 88082-3 |
| Composition.section:sliceRRSummarySection.code | example | Pattern: LOINC code 55112-7 |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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 | S | 0..* | USPublicHealthComposition | Reportability Response Composition | ||||
| 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 | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sliceExtensionVersionNumber | S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber | ||||
| sliceExtensionInformationRecipient | S | 1..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Reportability Response recipient(s) URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 1..1 | Identifier | Public Health Composition identifier | ||||
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | SΣ | 1..1 | CodeableConcept | Public Health Reportability Response Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88085-6 | |||||
| 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 | |||||
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject | SΣ | 1..1 | Reference(US Public Health Patient) | Patient | ||||
| encounter | SΣ | 1..1 | Reference(eICR Encounter) | eICR Encounter | ||||
| date | SΣ | 1..1 | dateTime | Composition editing time | ||||
| author | SΣ | 1..* | Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole) | Author | ||||
| title | SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| 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 | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian | SΣ | 1..1 | Reference(US Public Health Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code | ||||
| relatesTo: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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target[x] | 1..1 | Target of the relationship | ||||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(Composition) | |||||||
| relatesTo:sliceTransformed | S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | ||||
| 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms | ||||
| target[x] | S | 1..1 | Identifier | Identifier of the Document or Composition transformed | ||||
| relatesTo:sliceReplaced | S | 0..1 | BackboneElement | Document or Composition that this Composition replaces | ||||
| 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces | ||||
| target[x] | S | 1..1 | Identifier/Reference to the Document or Composition transformed | |||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(Composition) | |||||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| 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 | Σ | 0..* | CodeableConcept | Code(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..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code | ||||
| section: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 | ||||
| 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 | ||||
| section:sliceRRSubjectSection | SC | 0..1 | BackboneElement | Reportability Response Subject Section | ||||
| 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 | S | 1..1 | CodeableConcept | Reportable condition response information and summary Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88084-9 | |||||
| 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 | |||||
| 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 | SC | 1..1 | Narrative | Reportability Response Subject Section | ||||
| 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 | ||||
| section:sliceEICRSection | SC | 1..1 | BackboneElement | Electronic Initial Case Report Section | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extensionEICRProcessingStatus | S | 1..1 | (Complex) | eICR Processing Status URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension | ||||
| extensionAlternatelyManuallyInitiatedEICR | S | 0..1 | CodeableConcept | Alternately or Manually Initiated eICR URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension Binding: eICR Initiation (extensible): Initiation Types | ||||
| extensionEICRReceiptTime | S | 0..1 | dateTime | Date and time of eICR receipt URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | S | 1..1 | CodeableConcept | Initial case report processing information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88082-3 | |||||
| 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 | |||||
| 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. | |||||
| Slices for entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() | ||||
| entry:sliceEICRDocument | SC | 0..* | Reference(eICR Document Bundle | US Core DocumentReference Profile) | Reference to eICR Document Bundle or eICR CDA document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | eICR Document Bundle identifier | ||||
| display | SΣ | 0..1 | string | Filename of eICR | ||||
| 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 | ||||
| section:sliceRRSummarySection | SC | 0..1 | BackboneElement | Reportability Response Summary Section | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extensionRRPriority | S | 1..1 | CodeableConcept | RR Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | S | 1..1 | CodeableConcept | Document summary Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 55112-7 | |||||
| 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 | |||||
| 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 | SC | 1..1 | Narrative | RR Summary Section narrative | ||||
| 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. | |||||
| Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() | ||||
| entry:sliceRRSummary | SC | 1..1 | Reference(RR Summary) | RR Summary | ||||
| entry:sliceRRCondition | SC | 1..* | Reference(RR Relevant Reportable Condition Observation) | Relevant Reportable Condition | ||||
| 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 | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | Pattern: LOINC code 88085-6 | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transforms | ||||
| Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaces | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:sliceRRSubjectSection.code | example | Pattern: LOINC code 88084-9 | ||||
| Composition.section:sliceRRSubjectSection.mode | required | ListMode | ||||
| Composition.section:sliceRRSubjectSection.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:sliceRRSubjectSection.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:sliceEICRSection.code | example | Pattern: LOINC code 88082-3 | ||||
| Composition.section:sliceEICRSection.mode | required | ListMode | ||||
| Composition.section:sliceEICRSection.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:sliceEICRSection.entry:sliceEICRDocument.type | extensible | ResourceType | ||||
| Composition.section:sliceEICRSection.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:sliceRRSummarySection.code | example | Pattern: LOINC code 55112-7 | ||||
| Composition.section:sliceRRSummarySection.mode | required | ListMode | ||||
| Composition.section:sliceRRSummarySection.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:sliceRRSummarySection.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySection | 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 USPublicHealthComposition
Summary
Mandatory: 7 elements (8 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 2 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
IG © 2020+ HL7 International / Public Health. Package hl7.fhir.us.ecr#2.1.1 based on FHIR 4.0.1. Generated 2023-12-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change