Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot United States of America flag

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot 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

Resource Profile: RR Composition

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: RRComposition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.14

This Composition profile represents the Reportability Response that is created in response to an electronic Initial Case Report Composition.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Composition 0..* USPublicHealthComposition Reportability Response Composition
Composition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Composition.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for extension.extension:extensionVersionNumber This element must be supported. 1..1 string Public Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
Composition.Slices for extension.extension:extensionInformationRecipient This element must be supported. 1..* Reference(US Core Practitioner Profile(6.1.0) | US Public Health PractitionerRole | US Public Health Organization) Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension
Composition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Composition.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Public Health Composition identifier
Composition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Public Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88085-6"
    }
  ]
}
Composition.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) Patient
Composition.encounter This element must be supported. This element is included in summaries. 1..1 Reference(eICR Encounter) eICR Encounter
Composition.date This element must be supported. This element is included in summaries. 1..1 dateTime (USCDI+) Date of the Report
Composition.author This element must be supported. This element is included in summaries. 1..* Reference(US Public Health PractitionerRole | US Core Practitioner Profile(6.1.0) | US Public Health Organization | Device) The author(s) of the document. For the Reportability Response Composition, this will most likely be the software that is generating the response, though this will not always the be case.
Composition.title This element must be supported. This element is included in summaries. 1..1 string Human Readable name/title
Composition.custodian This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Organization) Custodian Organization Address, Custodian Organization Id, Custodian Organization Name, Custodian Organization Telecom (contained in referenced US Public Health Organization)
Composition.Slices for relatesTo This element must be supported. 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
Composition.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:All Slices.code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Composition.Slices for relatesTo.relatesTo:All Slices.target[x] 1..1 Target of the relationship
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetReference Reference(Composition)
Composition.Slices for relatesTo.relatesTo:transformed This element must be supported. 0..1 BackboneElement Document or Composition that this Composition is transformed from
Composition.Slices for relatesTo.relatesTo:transformed.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:transformed.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: transforms (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:transformed.target[x] This element must be supported. 1..1 Identifier Identifier of the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced This element must be supported. 0..1 BackboneElement Document or Composition that this Composition replaces
Composition.Slices for relatesTo.relatesTo:replaced.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:replaced.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: replaces (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:replaced.target[x] This element must be supported. 1..1 Identifier/Reference to the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetReference Reference(Composition)
Composition.Slices for section C 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:All Slices Content/Rules for all slices
Composition.Slices for section.section:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSubjectSection This element must be supported. C 0..1 BackboneElement Reportability Response Subject Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSubjectSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSubjectSection.code This element must be supported. 1..1 CodeableConcept Reportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88084-9"
    }
  ]
}
Composition.Slices for section.section:sliceRRSubjectSection.text This element must be supported. C 1..1 Narrative Reportability Response Subject Section
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceEICRSection This element must be supported. C 1..1 BackboneElement Electronic Initial Case Report Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceEICRSection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRProcessingStatus This element must be supported. 1..1 (Complex) eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionAlternatelyManuallyInitiatedEICR This element must be supported. 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
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRReceiptTime This element must be supported. 0..1 dateTime Date and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
Composition.Slices for section.section:sliceEICRSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceEICRSection.code This element must be supported. 1..1 CodeableConcept Initial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88082-3"
    }
  ]
}
Composition.Slices for section.section:sliceEICRSection.Slices for entry This element must be supported. C 0..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument This element must be supported. C 0..* Reference(eICR Document Bundle | US Core DocumentReference Profile(6.1.0)) Reference to eICR Document Bundle or eICR CDA document
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.identifier This element is included in summaries. 0..1 Identifier eICR Document Bundle identifier
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.display This element must be supported. This element is included in summaries. 0..1 string Filename of eICR
Composition.Slices for section.section:sliceRRSummarySection This element must be supported. C 0..1 BackboneElement Reportability Response Summary Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension.extension:extensionRRPriority This element must be supported. 1..1 CodeableConcept RR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority
Composition.Slices for section.section:sliceRRSummarySection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSummarySection.code This element must be supported. 1..1 CodeableConcept Document summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "55112-7"
    }
  ]
}
Composition.Slices for section.section:sliceRRSummarySection.text This element must be supported. C 1..1 Narrative RR Summary Section narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry This element must be supported. C 2..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRSummary This element must be supported. C 1..1 Reference(RR Summary Observation) RR Summary
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRCondition This element must be supported. C 1..* Reference(RR Relevant Reportable Condition Observation) Relevant Reportable Condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:transformed.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:replaced.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Composition 0..* USPublicHealthComposition Reportability Response Composition
Composition.extension 2..* Extension Extension
Composition.Slices for extension Content/Rules for all slices
Composition.Slices for extension.extension:extensionInformationRecipient 1..* USPublicHealthInformationRecipientExtension Reportability Response recipient(s)
Composition.type 1..1 CodeableConcept Public Health Reportability Response Document
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88085-6"
    }
  ]
}
Composition.encounter 1..1 Reference(eICR Encounter) eICR Encounter
Composition.author 1..* Reference(US Public Health PractitionerRole | US Core Practitioner Profile(6.1.0) | US Public Health Organization | Device) The author(s) of the document. For the Reportability Response Composition, this will most likely be the software that is generating the response, though this will not always the be case.
Composition.custodian 1..1 Reference(US Public Health Organization) Custodian Organization Address, Custodian Organization Id, Custodian Organization Name, Custodian Organization Telecom (contained in referenced US Public Health Organization)
Composition.Slices for section 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSubjectSection This element must be supported. 0..1 BackboneElement Reportability Response Subject Section
Composition.Slices for section.section:sliceRRSubjectSection.code This element must be supported. 1..1 CodeableConcept Reportable condition response information and summary Document
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88084-9"
    }
  ]
}
Composition.Slices for section.section:sliceRRSubjectSection.text This element must be supported. 1..1 Narrative Reportability Response Subject Section
Composition.Slices for section.section:sliceEICRSection This element must be supported. 1..1 BackboneElement Electronic Initial Case Report Section
Composition.Slices for section.section:sliceEICRSection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRProcessingStatus This element must be supported. 1..1 (Complex) eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionAlternatelyManuallyInitiatedEICR This element must be supported. 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
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRReceiptTime This element must be supported. 0..1 dateTime Date and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
Composition.Slices for section.section:sliceEICRSection.code This element must be supported. 1..1 CodeableConcept Initial case report processing information Document
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88082-3"
    }
  ]
}
Composition.Slices for section.section:sliceEICRSection.Slices for entry This element must be supported. 0..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument This element must be supported. 0..* Reference(eICR Document Bundle | US Core DocumentReference Profile(6.1.0)) Reference to eICR Document Bundle or eICR CDA document
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.identifier 0..1 Identifier eICR Document Bundle identifier
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.display This element must be supported. 0..1 string Filename of eICR
Composition.Slices for section.section:sliceRRSummarySection This element must be supported. 0..1 BackboneElement Reportability Response Summary Section
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension.extension:extensionRRPriority This element must be supported. 1..1 CodeableConcept RR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority
Composition.Slices for section.section:sliceRRSummarySection.code This element must be supported. 1..1 CodeableConcept Document summary
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "55112-7"
    }
  ]
}
Composition.Slices for section.section:sliceRRSummarySection.text This element must be supported. 1..1 Narrative RR Summary Section narrative
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry This element must be supported. 2..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRSummary This element must be supported. 1..1 Reference(RR Summary Observation) RR Summary
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRCondition This element must be supported. 1..* Reference(RR Relevant Reportable Condition Observation) Relevant Reportable Condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Composition 0..* USPublicHealthComposition Reportability Response Composition
Composition.id This element is included in summaries. 0..1 id Logical id of this artifact
Composition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Composition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Composition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Composition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.contained 0..* Resource Contained, inline Resources
Composition.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for extension.extension:extensionVersionNumber This element must be supported. 1..1 string Public Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
Composition.Slices for extension.extension:extensionInformationRecipient This element must be supported. 1..* Reference(US Core Practitioner Profile(6.1.0) | US Public Health PractitionerRole | US Public Health Organization) Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension
Composition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Composition.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Public Health Composition identifier
Composition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Public Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88085-6"
    }
  ]
}
Composition.category This element is included in summaries. 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
Composition.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) Patient
Composition.encounter This element must be supported. This element is included in summaries. 1..1 Reference(eICR Encounter) eICR Encounter
Composition.date This element must be supported. This element is included in summaries. 1..1 dateTime (USCDI+) Date of the Report
Composition.author This element must be supported. This element is included in summaries. 1..* Reference(US Public Health PractitionerRole | US Core Practitioner Profile(6.1.0) | US Public Health Organization | Device) The author(s) of the document. For the Reportability Response Composition, this will most likely be the software that is generating the response, though this will not always the be case.
Composition.title This element must be supported. This element is included in summaries. 1..1 string Human Readable name/title
Composition.confidentiality This element is included in summaries. 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
Composition.attester 0..* BackboneElement Attests to accuracy of composition
Composition.attester.id 0..1 string Unique id for inter-element referencing
Composition.attester.extension 0..* Extension Additional content defined by implementations
Composition.attester.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.attester.mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Composition.attester.time 0..1 dateTime When the composition was attested
Composition.attester.party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
Composition.custodian This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Organization) Custodian Organization Address, Custodian Organization Id, Custodian Organization Name, Custodian Organization Telecom (contained in referenced US Public Health Organization)
Composition.Slices for relatesTo This element must be supported. 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
Composition.Slices for relatesTo.relatesTo:All Slices.id 0..1 string Unique id for inter-element referencing
Composition.Slices for relatesTo.relatesTo:All Slices.extension 0..* Extension Additional content defined by implementations
Composition.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:All Slices.code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Composition.Slices for relatesTo.relatesTo:All Slices.target[x] 1..1 Target of the relationship
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetReference Reference(Composition)
Composition.Slices for relatesTo.relatesTo:transformed This element must be supported. 0..1 BackboneElement Document or Composition that this Composition is transformed from
Composition.Slices for relatesTo.relatesTo:transformed.id 0..1 string Unique id for inter-element referencing
Composition.Slices for relatesTo.relatesTo:transformed.extension 0..* Extension Additional content defined by implementations
Composition.Slices for relatesTo.relatesTo:transformed.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:transformed.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: transforms (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:transformed.target[x] This element must be supported. 1..1 Identifier Identifier of the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced This element must be supported. 0..1 BackboneElement Document or Composition that this Composition replaces
Composition.Slices for relatesTo.relatesTo:replaced.id 0..1 string Unique id for inter-element referencing
Composition.Slices for relatesTo.relatesTo:replaced.extension 0..* Extension Additional content defined by implementations
Composition.Slices for relatesTo.relatesTo:replaced.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:replaced.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: replaces (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:replaced.target[x] This element must be supported. 1..1 Identifier/Reference to the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetReference Reference(Composition)
Composition.event This element is included in summaries. 0..* BackboneElement The clinical service(s) being documented
Composition.event.id 0..1 string Unique id for inter-element referencing
Composition.event.extension 0..* Extension Additional content defined by implementations
Composition.event.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.event.code This element is included in summaries. 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
Composition.event.period This element is included in summaries. 0..1 Period The period covered by the documentation
Composition.event.detail This element is included in summaries. 0..* Reference(Resource) The event(s) being documented
Composition.Slices for section C 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:All Slices Content/Rules for all slices
Composition.Slices for section.section:All Slices.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:All Slices.extension 0..* Extension Additional content defined by implementations
Composition.Slices for section.section:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:All Slices.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:All Slices.code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Composition.Slices for section.section:All Slices.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:All Slices.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:All Slices.text C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:All Slices.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:All Slices.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:All Slices.entry C 0..* Reference(Resource) A reference to data that supports this section
Composition.Slices for section.section:All Slices.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:All Slices.section C 0..* See section (Composition) Nested Section
Composition.Slices for section.section:sliceRRSubjectSection This element must be supported. C 0..1 BackboneElement Reportability Response Subject Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSubjectSection.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceRRSubjectSection.extension 0..* Extension Additional content defined by implementations
Composition.Slices for section.section:sliceRRSubjectSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSubjectSection.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:sliceRRSubjectSection.code This element must be supported. 1..1 CodeableConcept Reportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88084-9"
    }
  ]
}
Composition.Slices for section.section:sliceRRSubjectSection.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:sliceRRSubjectSection.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:sliceRRSubjectSection.text This element must be supported. C 1..1 Narrative Reportability Response Subject Section
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceRRSubjectSection.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:sliceRRSubjectSection.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:sliceRRSubjectSection.entry C 0..* Reference(Resource) A reference to data that supports this section
Composition.Slices for section.section:sliceRRSubjectSection.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:sliceRRSubjectSection.section C 0..* See section (Composition) Nested Section
Composition.Slices for section.section:sliceEICRSection This element must be supported. C 1..1 BackboneElement Electronic Initial Case Report Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceEICRSection.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceEICRSection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRProcessingStatus This element must be supported. 1..1 (Complex) eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionAlternatelyManuallyInitiatedEICR This element must be supported. 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
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRReceiptTime This element must be supported. 0..1 dateTime Date and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
Composition.Slices for section.section:sliceEICRSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceEICRSection.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:sliceEICRSection.code This element must be supported. 1..1 CodeableConcept Initial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88082-3"
    }
  ]
}
Composition.Slices for section.section:sliceEICRSection.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:sliceEICRSection.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:sliceEICRSection.text C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceEICRSection.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:sliceEICRSection.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:sliceEICRSection.Slices for entry This element must be supported. C 0..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument This element must be supported. C 0..* Reference(eICR Document Bundle | US Core DocumentReference Profile(6.1.0)) Reference to eICR Document Bundle or eICR CDA document
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.type This element is included in summaries. 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).
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.identifier This element is included in summaries. 0..1 Identifier eICR Document Bundle identifier
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.display This element must be supported. This element is included in summaries. 0..1 string Filename of eICR
Composition.Slices for section.section:sliceEICRSection.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:sliceEICRSection.section C 0..* See section (Composition) Nested Section
Composition.Slices for section.section:sliceRRSummarySection This element must be supported. C 0..1 BackboneElement Reportability Response Summary Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSummarySection.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension.extension:extensionRRPriority This element must be supported. 1..1 CodeableConcept RR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority
Composition.Slices for section.section:sliceRRSummarySection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSummarySection.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:sliceRRSummarySection.code This element must be supported. 1..1 CodeableConcept Document summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "55112-7"
    }
  ]
}
Composition.Slices for section.section:sliceRRSummarySection.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:sliceRRSummarySection.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:sliceRRSummarySection.text This element must be supported. C 1..1 Narrative RR Summary Section narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceRRSummarySection.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:sliceRRSummarySection.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry This element must be supported. C 2..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRSummary This element must be supported. C 1..1 Reference(RR Summary Observation) RR Summary
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRCondition This element must be supported. C 1..* Reference(RR Relevant Reportable Condition Observation) Relevant Reportable Condition
Composition.Slices for section.section:sliceRRSummarySection.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:sliceRRSummarySection.section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:transformed.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:replaced.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📍3.0.0 THO v7.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​entry:sliceEICRDocument.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Composition 0..* USPublicHealthComposition Reportability Response Composition
Composition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Composition.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for extension.extension:extensionVersionNumber This element must be supported. 1..1 string Public Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
Composition.Slices for extension.extension:extensionInformationRecipient This element must be supported. 1..* Reference(US Core Practitioner Profile(6.1.0) | US Public Health PractitionerRole | US Public Health Organization) Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension
Composition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Composition.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Public Health Composition identifier
Composition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Public Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88085-6"
    }
  ]
}
Composition.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) Patient
Composition.encounter This element must be supported. This element is included in summaries. 1..1 Reference(eICR Encounter) eICR Encounter
Composition.date This element must be supported. This element is included in summaries. 1..1 dateTime (USCDI+) Date of the Report
Composition.author This element must be supported. This element is included in summaries. 1..* Reference(US Public Health PractitionerRole | US Core Practitioner Profile(6.1.0) | US Public Health Organization | Device) The author(s) of the document. For the Reportability Response Composition, this will most likely be the software that is generating the response, though this will not always the be case.
Composition.title This element must be supported. This element is included in summaries. 1..1 string Human Readable name/title
Composition.custodian This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Organization) Custodian Organization Address, Custodian Organization Id, Custodian Organization Name, Custodian Organization Telecom (contained in referenced US Public Health Organization)
Composition.Slices for relatesTo This element must be supported. 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
Composition.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:All Slices.code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Composition.Slices for relatesTo.relatesTo:All Slices.target[x] 1..1 Target of the relationship
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetReference Reference(Composition)
Composition.Slices for relatesTo.relatesTo:transformed This element must be supported. 0..1 BackboneElement Document or Composition that this Composition is transformed from
Composition.Slices for relatesTo.relatesTo:transformed.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:transformed.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: transforms (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:transformed.target[x] This element must be supported. 1..1 Identifier Identifier of the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced This element must be supported. 0..1 BackboneElement Document or Composition that this Composition replaces
Composition.Slices for relatesTo.relatesTo:replaced.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:replaced.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: replaces (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:replaced.target[x] This element must be supported. 1..1 Identifier/Reference to the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetReference Reference(Composition)
Composition.Slices for section C 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:All Slices Content/Rules for all slices
Composition.Slices for section.section:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSubjectSection This element must be supported. C 0..1 BackboneElement Reportability Response Subject Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSubjectSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSubjectSection.code This element must be supported. 1..1 CodeableConcept Reportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88084-9"
    }
  ]
}
Composition.Slices for section.section:sliceRRSubjectSection.text This element must be supported. C 1..1 Narrative Reportability Response Subject Section
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceEICRSection This element must be supported. C 1..1 BackboneElement Electronic Initial Case Report Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceEICRSection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRProcessingStatus This element must be supported. 1..1 (Complex) eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionAlternatelyManuallyInitiatedEICR This element must be supported. 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
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRReceiptTime This element must be supported. 0..1 dateTime Date and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
Composition.Slices for section.section:sliceEICRSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceEICRSection.code This element must be supported. 1..1 CodeableConcept Initial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88082-3"
    }
  ]
}
Composition.Slices for section.section:sliceEICRSection.Slices for entry This element must be supported. C 0..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument This element must be supported. C 0..* Reference(eICR Document Bundle | US Core DocumentReference Profile(6.1.0)) Reference to eICR Document Bundle or eICR CDA document
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.identifier This element is included in summaries. 0..1 Identifier eICR Document Bundle identifier
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.display This element must be supported. This element is included in summaries. 0..1 string Filename of eICR
Composition.Slices for section.section:sliceRRSummarySection This element must be supported. C 0..1 BackboneElement Reportability Response Summary Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension.extension:extensionRRPriority This element must be supported. 1..1 CodeableConcept RR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority
Composition.Slices for section.section:sliceRRSummarySection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSummarySection.code This element must be supported. 1..1 CodeableConcept Document summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "55112-7"
    }
  ]
}
Composition.Slices for section.section:sliceRRSummarySection.text This element must be supported. C 1..1 Narrative RR Summary Section narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry This element must be supported. C 2..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRSummary This element must be supported. C 1..1 Reference(RR Summary Observation) RR Summary
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRCondition This element must be supported. C 1..* Reference(RR Relevant Reportable Condition Observation) Relevant Reportable Condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:transformed.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:replaced.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from USPublicHealthComposition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Composition 0..* USPublicHealthComposition Reportability Response Composition
Composition.extension 2..* Extension Extension
Composition.Slices for extension Content/Rules for all slices
Composition.Slices for extension.extension:extensionInformationRecipient 1..* USPublicHealthInformationRecipientExtension Reportability Response recipient(s)
Composition.type 1..1 CodeableConcept Public Health Reportability Response Document
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88085-6"
    }
  ]
}
Composition.subject 1..1 Reference(US Public Health Patient) Patient
Composition.encounter 1..1 Reference(eICR Encounter) eICR Encounter
Composition.author 1..* Reference(US Public Health PractitionerRole | US Core Practitioner Profile(6.1.0) | US Public Health Organization | Device) The author(s) of the document. For the Reportability Response Composition, this will most likely be the software that is generating the response, though this will not always the be case.
Composition.custodian 1..1 Reference(US Public Health Organization) Custodian Organization Address, Custodian Organization Id, Custodian Organization Name, Custodian Organization Telecom (contained in referenced US Public Health Organization)
Composition.Slices for section 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSubjectSection This element must be supported. 0..1 BackboneElement Reportability Response Subject Section
Composition.Slices for section.section:sliceRRSubjectSection.code This element must be supported. 1..1 CodeableConcept Reportable condition response information and summary Document
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88084-9"
    }
  ]
}
Composition.Slices for section.section:sliceRRSubjectSection.text This element must be supported. 1..1 Narrative Reportability Response Subject Section
Composition.Slices for section.section:sliceEICRSection This element must be supported. 1..1 BackboneElement Electronic Initial Case Report Section
Composition.Slices for section.section:sliceEICRSection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRProcessingStatus This element must be supported. 1..1 (Complex) eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionAlternatelyManuallyInitiatedEICR This element must be supported. 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
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRReceiptTime This element must be supported. 0..1 dateTime Date and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
Composition.Slices for section.section:sliceEICRSection.code This element must be supported. 1..1 CodeableConcept Initial case report processing information Document
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88082-3"
    }
  ]
}
Composition.Slices for section.section:sliceEICRSection.Slices for entry This element must be supported. 0..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument This element must be supported. 0..* Reference(eICR Document Bundle | US Core DocumentReference Profile(6.1.0)) Reference to eICR Document Bundle or eICR CDA document
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.identifier 0..1 Identifier eICR Document Bundle identifier
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.display This element must be supported. 0..1 string Filename of eICR
Composition.Slices for section.section:sliceRRSummarySection This element must be supported. 0..1 BackboneElement Reportability Response Summary Section
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension.extension:extensionRRPriority This element must be supported. 1..1 CodeableConcept RR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority
Composition.Slices for section.section:sliceRRSummarySection.code This element must be supported. 1..1 CodeableConcept Document summary
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "55112-7"
    }
  ]
}
Composition.Slices for section.section:sliceRRSummarySection.text This element must be supported. 1..1 Narrative RR Summary Section narrative
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry This element must be supported. 2..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRSummary This element must be supported. 1..1 Reference(RR Summary Observation) RR Summary
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRCondition This element must be supported. 1..* Reference(RR Relevant Reportable Condition Observation) Relevant Reportable Condition

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Composition 0..* USPublicHealthComposition Reportability Response Composition
Composition.id This element is included in summaries. 0..1 id Logical id of this artifact
Composition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Composition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Composition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Composition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.contained 0..* Resource Contained, inline Resources
Composition.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for extension.extension:extensionVersionNumber This element must be supported. 1..1 string Public Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
Composition.Slices for extension.extension:extensionInformationRecipient This element must be supported. 1..* Reference(US Core Practitioner Profile(6.1.0) | US Public Health PractitionerRole | US Public Health Organization) Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension
Composition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Composition.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Public Health Composition identifier
Composition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
Composition.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Public Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88085-6"
    }
  ]
}
Composition.category This element is included in summaries. 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
Composition.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) Patient
Composition.encounter This element must be supported. This element is included in summaries. 1..1 Reference(eICR Encounter) eICR Encounter
Composition.date This element must be supported. This element is included in summaries. 1..1 dateTime (USCDI+) Date of the Report
Composition.author This element must be supported. This element is included in summaries. 1..* Reference(US Public Health PractitionerRole | US Core Practitioner Profile(6.1.0) | US Public Health Organization | Device) The author(s) of the document. For the Reportability Response Composition, this will most likely be the software that is generating the response, though this will not always the be case.
Composition.title This element must be supported. This element is included in summaries. 1..1 string Human Readable name/title
Composition.confidentiality This element is included in summaries. 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
Composition.attester 0..* BackboneElement Attests to accuracy of composition
Composition.attester.id 0..1 string Unique id for inter-element referencing
Composition.attester.extension 0..* Extension Additional content defined by implementations
Composition.attester.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.attester.mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Composition.attester.time 0..1 dateTime When the composition was attested
Composition.attester.party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
Composition.custodian This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Organization) Custodian Organization Address, Custodian Organization Id, Custodian Organization Name, Custodian Organization Telecom (contained in referenced US Public Health Organization)
Composition.Slices for relatesTo This element must be supported. 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
Composition.Slices for relatesTo.relatesTo:All Slices.id 0..1 string Unique id for inter-element referencing
Composition.Slices for relatesTo.relatesTo:All Slices.extension 0..* Extension Additional content defined by implementations
Composition.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:All Slices.code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Composition.Slices for relatesTo.relatesTo:All Slices.target[x] 1..1 Target of the relationship
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:All Slices.target[x].targetReference Reference(Composition)
Composition.Slices for relatesTo.relatesTo:transformed This element must be supported. 0..1 BackboneElement Document or Composition that this Composition is transformed from
Composition.Slices for relatesTo.relatesTo:transformed.id 0..1 string Unique id for inter-element referencing
Composition.Slices for relatesTo.relatesTo:transformed.extension 0..* Extension Additional content defined by implementations
Composition.Slices for relatesTo.relatesTo:transformed.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:transformed.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: transforms (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:transformed.target[x] This element must be supported. 1..1 Identifier Identifier of the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced This element must be supported. 0..1 BackboneElement Document or Composition that this Composition replaces
Composition.Slices for relatesTo.relatesTo:replaced.id 0..1 string Unique id for inter-element referencing
Composition.Slices for relatesTo.relatesTo:replaced.extension 0..* Extension Additional content defined by implementations
Composition.Slices for relatesTo.relatesTo:replaced.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for relatesTo.relatesTo:replaced.code This element must be supported. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: replaces (no extensions allowed)
Composition.Slices for relatesTo.relatesTo:replaced.target[x] This element must be supported. 1..1 Identifier/Reference to the Document or Composition transformed
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetIdentifier Identifier
Composition.Slices for relatesTo.relatesTo:replaced.target[x].targetReference Reference(Composition)
Composition.event This element is included in summaries. 0..* BackboneElement The clinical service(s) being documented
Composition.event.id 0..1 string Unique id for inter-element referencing
Composition.event.extension 0..* Extension Additional content defined by implementations
Composition.event.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.event.code This element is included in summaries. 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
Composition.event.period This element is included in summaries. 0..1 Period The period covered by the documentation
Composition.event.detail This element is included in summaries. 0..* Reference(Resource) The event(s) being documented
Composition.Slices for section C 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:All Slices Content/Rules for all slices
Composition.Slices for section.section:All Slices.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:All Slices.extension 0..* Extension Additional content defined by implementations
Composition.Slices for section.section:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:All Slices.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:All Slices.code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Composition.Slices for section.section:All Slices.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:All Slices.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:All Slices.text C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:All Slices.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:All Slices.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:All Slices.entry C 0..* Reference(Resource) A reference to data that supports this section
Composition.Slices for section.section:All Slices.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:All Slices.section C 0..* See section (Composition) Nested Section
Composition.Slices for section.section:sliceRRSubjectSection This element must be supported. C 0..1 BackboneElement Reportability Response Subject Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSubjectSection.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceRRSubjectSection.extension 0..* Extension Additional content defined by implementations
Composition.Slices for section.section:sliceRRSubjectSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSubjectSection.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:sliceRRSubjectSection.code This element must be supported. 1..1 CodeableConcept Reportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88084-9"
    }
  ]
}
Composition.Slices for section.section:sliceRRSubjectSection.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:sliceRRSubjectSection.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:sliceRRSubjectSection.text This element must be supported. C 1..1 Narrative Reportability Response Subject Section
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceRRSubjectSection.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:sliceRRSubjectSection.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:sliceRRSubjectSection.entry C 0..* Reference(Resource) A reference to data that supports this section
Composition.Slices for section.section:sliceRRSubjectSection.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:sliceRRSubjectSection.section C 0..* See section (Composition) Nested Section
Composition.Slices for section.section:sliceEICRSection This element must be supported. C 1..1 BackboneElement Electronic Initial Case Report Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceEICRSection.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceEICRSection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRProcessingStatus This element must be supported. 1..1 (Complex) eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionAlternatelyManuallyInitiatedEICR This element must be supported. 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
Composition.Slices for section.section:sliceEICRSection.Slices for extension.extension:extensionEICRReceiptTime This element must be supported. 0..1 dateTime Date and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
Composition.Slices for section.section:sliceEICRSection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceEICRSection.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:sliceEICRSection.code This element must be supported. 1..1 CodeableConcept Initial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "88082-3"
    }
  ]
}
Composition.Slices for section.section:sliceEICRSection.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:sliceEICRSection.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:sliceEICRSection.text C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceEICRSection.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:sliceEICRSection.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:sliceEICRSection.Slices for entry This element must be supported. C 0..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceEICRSection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument This element must be supported. C 0..* Reference(eICR Document Bundle | US Core DocumentReference Profile(6.1.0)) Reference to eICR Document Bundle or eICR CDA document
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.type This element is included in summaries. 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).
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.identifier This element is included in summaries. 0..1 Identifier eICR Document Bundle identifier
Composition.Slices for section.section:sliceEICRSection.Slices for entry.entry:sliceEICRDocument.display This element must be supported. This element is included in summaries. 0..1 string Filename of eICR
Composition.Slices for section.section:sliceEICRSection.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:sliceEICRSection.section C 0..* See section (Composition) Nested Section
Composition.Slices for section.section:sliceRRSummarySection This element must be supported. C 0..1 BackboneElement Reportability Response Summary Section
Constraints: cmp-1, cmp-2
Composition.Slices for section.section:sliceRRSummarySection.id 0..1 string Unique id for inter-element referencing
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for extension.extension:extensionRRPriority This element must be supported. 1..1 CodeableConcept RR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority
Composition.Slices for section.section:sliceRRSummarySection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Composition.Slices for section.section:sliceRRSummarySection.title 0..1 string Label for section (e.g. for ToC)
Composition.Slices for section.section:sliceRRSummarySection.code This element must be supported. 1..1 CodeableConcept Document summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "55112-7"
    }
  ]
}
Composition.Slices for section.section:sliceRRSummarySection.author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
Composition.Slices for section.section:sliceRRSummarySection.focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
Composition.Slices for section.section:sliceRRSummarySection.text This element must be supported. C 1..1 Narrative RR Summary Section narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Composition.Slices for section.section:sliceRRSummarySection.mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
Composition.Slices for section.section:sliceRRSummarySection.orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry This element must be supported. C 2..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry Content/Rules for all slices
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRSummary This element must be supported. C 1..1 Reference(RR Summary Observation) RR Summary
Composition.Slices for section.section:sliceRRSummarySection.Slices for entry.entry:sliceRRCondition This element must be supported. C 1..* Reference(RR Relevant Reportable Condition Observation) Relevant Reportable Condition
Composition.Slices for section.section:sliceRRSummarySection.emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
Composition.Slices for section.section:sliceRRSummarySection.section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:transformed.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.relatesTo:replaced.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📍3.0.0 THO v7.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSubjectSection.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​entry:sliceEICRDocument.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:sliceEICRSection.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:sliceRRSummarySection.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

 

Other representations of profile: CSV, Excel, Schematron