HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.1 - STU 2.1.1 United States of America flag

This page is part of the electronic Case Reporting (eCR) (v2.1.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in it's permanent location. For a full list of available versions, see the Directory of published versions

Resource Profile: RR Composition

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition Version: 2.1.1
Active as of 2023-12-14 Computable Name: RRComposition

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

Usage:

Formal Views of Profile Content

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

This structure is derived from USPublicHealthComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition S0..*USPublicHealthCompositionReportability Response Composition
... sliceExtensionInformationRecipient 1..*Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization)Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension
... type S1..1CodeableConceptPublic Health Reportability Response Document
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88085-6
... subject S1..1Reference(US Public Health Patient)Patient
... author S1..*Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole)Author
... custodian 1..1Reference(US Public Health Organization)Organization which maintains the composition
... Slices for relatesTo S0..*BackboneElementRelationships to other compositions/documents
Slice: Unordered, Open by value:code
.... relatesTo:sliceTransformed 0..1BackboneElementDocument or Composition that this Composition is transformed from
..... code 1..1codereplaces | transforms | signs | appends
Fixed Value: transforms
..... target[x] 1..1IdentifierIdentifier of the Document or Composition transformed
.... relatesTo:sliceReplaced 0..1BackboneElementDocument or Composition that this Composition replaces
..... code 1..1codereplaces | transforms | signs | appends
Fixed Value: replaces
..... target[x] 1..1Identifier, Reference(Composition)Identifier/Reference to the Document or Composition transformed
... Slices for section 0..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:sliceRRSubjectSection S0..1BackboneElementReportability Response Subject Section
..... code S1..1CodeableConceptReportable condition response information and summary Document
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88084-9
..... text S1..1NarrativeReportability Response Subject Section
.... section:sliceEICRSection S1..1BackboneElementElectronic Initial Case Report Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionEICRProcessingStatus S1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
..... extensionAlternatelyManuallyInitiatedEICR S0..1CodeableConceptAlternately or Manually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension
Binding: eICR Initiation (extensible): Initiation Types

..... extensionEICRReceiptTime S0..1dateTimeDate and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
..... code S1..1CodeableConceptInitial case report processing information Document
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88082-3
..... Slices for entry S0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceEICRDocument S0..*Reference(eICR Document Bundle | US Core DocumentReference Profile)Reference to eICR Document Bundle or eICR CDA document
....... identifier 0..1IdentifiereICR Document Bundle identifier
....... display S0..1stringFilename of eICR
.... section:sliceRRSummarySection S0..1BackboneElementReportability Response Summary Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionRRPriority S1..1CodeableConceptRR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority

..... code S1..1CodeableConceptDocument summary
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55112-7
..... text S1..1NarrativeRR Summary Section narrative
..... Slices for entry S1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceRRSummary S1..1Reference(RR Summary)RR Summary
...... entry:sliceRRCondition S1..*Reference(RR Relevant Reportable Condition Observation)Relevant Reportable Condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition S0..*USPublicHealthCompositionReportability Response Composition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... sliceExtensionVersionNumber S1..1stringPublic Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierPublic Health Composition identifier
... status ?!SΣ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ1..1CodeableConceptPublic Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88085-6
... subject SΣ1..1Reference(US Public Health Patient)Patient
... encounter SΣ1..1Reference(eICR Encounter)eICR Encounter
... date SΣ1..1dateTimeComposition editing time
... author SΣ1..*Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole)Author
... title SΣ1..1stringHuman Readable name/title
... custodian SΣ1..1Reference(US Public Health Organization)Organization which maintains the composition
... Slices for relatesTo S0..*BackboneElementRelationships to other compositions/documents
Slice: Unordered, Open by value:code
.... relatesTo:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

..... target[x] 1..1Target of the relationship
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
.... relatesTo:sliceTransformed S0..1BackboneElementDocument or Composition that this Composition is transformed from
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: transforms
..... target[x] S1..1IdentifierIdentifier of the Document or Composition transformed
.... relatesTo:sliceReplaced S0..1BackboneElementDocument or Composition that this Composition replaces
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: replaces
..... target[x] S1..1Identifier/Reference to the Document or Composition transformed
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
... Slices for section C0..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... section:sliceRRSubjectSection SC0..1BackboneElementReportability Response Subject Section
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptReportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88084-9
..... text SC1..1NarrativeReportability Response Subject Section
.... section:sliceEICRSection SC1..1BackboneElementElectronic Initial Case Report Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionEICRProcessingStatus S1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
..... extensionAlternatelyManuallyInitiatedEICR S0..1CodeableConceptAlternately or Manually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension
Binding: eICR Initiation (extensible): Initiation Types


..... extensionEICRReceiptTime S0..1dateTimeDate and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptInitial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88082-3
..... Slices for entry SC0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceEICRDocument SC0..*Reference(eICR Document Bundle | US Core DocumentReference Profile)Reference to eICR Document Bundle or eICR CDA document
....... identifier Σ0..1IdentifiereICR Document Bundle identifier
....... display SΣ0..1stringFilename of eICR
.... section:sliceRRSummarySection SC0..1BackboneElementReportability Response Summary Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionRRPriority S1..1CodeableConceptRR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority


..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptDocument summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55112-7
..... text SC1..1NarrativeRR Summary Section narrative
..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceRRSummary SC1..1Reference(RR Summary)RR Summary
...... entry:sliceRRCondition SC1..*Reference(RR Relevant Reportable Condition Observation)Relevant Reportable Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.statusrequiredCompositionStatus
Composition.typepreferredPattern: LOINC code 88085-6
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.relatesTo:sliceTransformed.coderequiredFixed Value: transforms
Composition.relatesTo:sliceReplaced.coderequiredFixed Value: replaces
Composition.section:sliceRRSubjectSection.codeexamplePattern: LOINC code 88084-9
Composition.section:sliceEICRSection.codeexamplePattern: LOINC code 88082-3
Composition.section:sliceRRSummarySection.codeexamplePattern: LOINC code 55112-7

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition S0..*USPublicHealthCompositionReportability Response Composition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... sliceExtensionVersionNumber S1..1stringPublic Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... sliceExtensionInformationRecipient S1..*Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization)Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierPublic Health Composition identifier
... status ?!SΣ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ1..1CodeableConceptPublic Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88085-6
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... category Σ0..*CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ1..1Reference(US Public Health Patient)Patient
... encounter SΣ1..1Reference(eICR Encounter)eICR Encounter
... date SΣ1..1dateTimeComposition editing time
... author SΣ1..*Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole)Author
... title SΣ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
... custodian SΣ1..1Reference(US Public Health Organization)Organization which maintains the composition
... Slices for relatesTo S0..*BackboneElementRelationships to other compositions/documents
Slice: Unordered, Open by value:code
.... relatesTo:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

..... target[x] 1..1Target of the relationship
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
.... relatesTo:sliceTransformed S0..1BackboneElementDocument or Composition that this Composition is transformed from
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: transforms
..... target[x] S1..1IdentifierIdentifier of the Document or Composition transformed
.... relatesTo:sliceReplaced S0..1BackboneElementDocument or Composition that this Composition replaces
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: replaces
..... target[x] S1..1Identifier/Reference to the Document or Composition transformed
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... Slices for section C0..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

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

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

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

..... section C0..*See section (Composition)Nested Section
.... section:sliceRRSubjectSection SC0..1BackboneElementReportability Response Subject Section
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code S1..1CodeableConceptReportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88084-9
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text SC1..1NarrativeReportability Response Subject Section
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

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

..... section C0..*See section (Composition)Nested Section
.... section:sliceEICRSection SC1..1BackboneElementElectronic Initial Case Report Section
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionEICRProcessingStatus S1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
..... extensionAlternatelyManuallyInitiatedEICR S0..1CodeableConceptAlternately or Manually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension
Binding: eICR Initiation (extensible): Initiation Types


..... extensionEICRReceiptTime S0..1dateTimeDate and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code S1..1CodeableConceptInitial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88082-3
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... Slices for entry SC0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceEICRDocument SC0..*Reference(eICR Document Bundle | US Core DocumentReference Profile)Reference to eICR Document Bundle or eICR CDA document
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifiereICR Document Bundle identifier
....... display SΣ0..1stringFilename of eICR
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:sliceRRSummarySection SC0..1BackboneElementReportability Response Summary Section
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionRRPriority S1..1CodeableConceptRR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority


..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code S1..1CodeableConceptDocument summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55112-7
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text SC1..1NarrativeRR Summary Section narrative
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceRRSummary SC1..1Reference(RR Summary)RR Summary
...... entry:sliceRRCondition SC1..*Reference(RR Relevant Reportable Condition Observation)Relevant Reportable Condition
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
Composition.typepreferredPattern: LOINC code 88085-6
Composition.categoryexampleDocumentClassValueSet
Composition.confidentialityrequiredv3.ConfidentialityClassification
Composition.attester.moderequiredCompositionAttestationMode
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.relatesTo:sliceTransformed.coderequiredFixed Value: transforms
Composition.relatesTo:sliceReplaced.coderequiredFixed Value: replaces
Composition.event.codeexampleActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons
Composition.section:sliceRRSubjectSection.codeexamplePattern: LOINC code 88084-9
Composition.section:sliceRRSubjectSection.moderequiredListMode
Composition.section:sliceRRSubjectSection.orderedBypreferredListOrderCodes
Composition.section:sliceRRSubjectSection.emptyReasonpreferredListEmptyReasons
Composition.section:sliceEICRSection.codeexamplePattern: LOINC code 88082-3
Composition.section:sliceEICRSection.moderequiredListMode
Composition.section:sliceEICRSection.orderedBypreferredListOrderCodes
Composition.section:sliceEICRSection.entry:sliceEICRDocument.typeextensibleResourceType
Composition.section:sliceEICRSection.emptyReasonpreferredListEmptyReasons
Composition.section:sliceRRSummarySection.codeexamplePattern: LOINC code 55112-7
Composition.section:sliceRRSummarySection.moderequiredListMode
Composition.section:sliceRRSummarySection.orderedBypreferredListOrderCodes
Composition.section:sliceRRSummarySection.emptyReasonpreferredListEmptyReasons

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USPublicHealthComposition

Summary

Mandatory: 7 elements (8 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Composition.relatesTo is sliced based on the value of value:code
  • The element Composition.section is sliced based on the value of value:code
  • The element Composition.section.entry is sliced based on the value of profile:resolve()

Differential View

This structure is derived from USPublicHealthComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition S0..*USPublicHealthCompositionReportability Response Composition
... sliceExtensionInformationRecipient 1..*Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization)Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension
... type S1..1CodeableConceptPublic Health Reportability Response Document
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88085-6
... subject S1..1Reference(US Public Health Patient)Patient
... author S1..*Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole)Author
... custodian 1..1Reference(US Public Health Organization)Organization which maintains the composition
... Slices for relatesTo S0..*BackboneElementRelationships to other compositions/documents
Slice: Unordered, Open by value:code
.... relatesTo:sliceTransformed 0..1BackboneElementDocument or Composition that this Composition is transformed from
..... code 1..1codereplaces | transforms | signs | appends
Fixed Value: transforms
..... target[x] 1..1IdentifierIdentifier of the Document or Composition transformed
.... relatesTo:sliceReplaced 0..1BackboneElementDocument or Composition that this Composition replaces
..... code 1..1codereplaces | transforms | signs | appends
Fixed Value: replaces
..... target[x] 1..1Identifier, Reference(Composition)Identifier/Reference to the Document or Composition transformed
... Slices for section 0..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:sliceRRSubjectSection S0..1BackboneElementReportability Response Subject Section
..... code S1..1CodeableConceptReportable condition response information and summary Document
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88084-9
..... text S1..1NarrativeReportability Response Subject Section
.... section:sliceEICRSection S1..1BackboneElementElectronic Initial Case Report Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionEICRProcessingStatus S1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
..... extensionAlternatelyManuallyInitiatedEICR S0..1CodeableConceptAlternately or Manually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension
Binding: eICR Initiation (extensible): Initiation Types

..... extensionEICRReceiptTime S0..1dateTimeDate and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
..... code S1..1CodeableConceptInitial case report processing information Document
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88082-3
..... Slices for entry S0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceEICRDocument S0..*Reference(eICR Document Bundle | US Core DocumentReference Profile)Reference to eICR Document Bundle or eICR CDA document
....... identifier 0..1IdentifiereICR Document Bundle identifier
....... display S0..1stringFilename of eICR
.... section:sliceRRSummarySection S0..1BackboneElementReportability Response Summary Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionRRPriority S1..1CodeableConceptRR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority

..... code S1..1CodeableConceptDocument summary
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55112-7
..... text S1..1NarrativeRR Summary Section narrative
..... Slices for entry S1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceRRSummary S1..1Reference(RR Summary)RR Summary
...... entry:sliceRRCondition S1..*Reference(RR Relevant Reportable Condition Observation)Relevant Reportable Condition

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition S0..*USPublicHealthCompositionReportability Response Composition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... sliceExtensionVersionNumber S1..1stringPublic Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierPublic Health Composition identifier
... status ?!SΣ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ1..1CodeableConceptPublic Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88085-6
... subject SΣ1..1Reference(US Public Health Patient)Patient
... encounter SΣ1..1Reference(eICR Encounter)eICR Encounter
... date SΣ1..1dateTimeComposition editing time
... author SΣ1..*Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole)Author
... title SΣ1..1stringHuman Readable name/title
... custodian SΣ1..1Reference(US Public Health Organization)Organization which maintains the composition
... Slices for relatesTo S0..*BackboneElementRelationships to other compositions/documents
Slice: Unordered, Open by value:code
.... relatesTo:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

..... target[x] 1..1Target of the relationship
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
.... relatesTo:sliceTransformed S0..1BackboneElementDocument or Composition that this Composition is transformed from
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: transforms
..... target[x] S1..1IdentifierIdentifier of the Document or Composition transformed
.... relatesTo:sliceReplaced S0..1BackboneElementDocument or Composition that this Composition replaces
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: replaces
..... target[x] S1..1Identifier/Reference to the Document or Composition transformed
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
... Slices for section C0..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... section:sliceRRSubjectSection SC0..1BackboneElementReportability Response Subject Section
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptReportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88084-9
..... text SC1..1NarrativeReportability Response Subject Section
.... section:sliceEICRSection SC1..1BackboneElementElectronic Initial Case Report Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionEICRProcessingStatus S1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
..... extensionAlternatelyManuallyInitiatedEICR S0..1CodeableConceptAlternately or Manually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension
Binding: eICR Initiation (extensible): Initiation Types


..... extensionEICRReceiptTime S0..1dateTimeDate and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptInitial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88082-3
..... Slices for entry SC0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceEICRDocument SC0..*Reference(eICR Document Bundle | US Core DocumentReference Profile)Reference to eICR Document Bundle or eICR CDA document
....... identifier Σ0..1IdentifiereICR Document Bundle identifier
....... display SΣ0..1stringFilename of eICR
.... section:sliceRRSummarySection SC0..1BackboneElementReportability Response Summary Section
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionRRPriority S1..1CodeableConceptRR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority


..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptDocument summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55112-7
..... text SC1..1NarrativeRR Summary Section narrative
..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceRRSummary SC1..1Reference(RR Summary)RR Summary
...... entry:sliceRRCondition SC1..*Reference(RR Relevant Reportable Condition Observation)Relevant Reportable Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.statusrequiredCompositionStatus
Composition.typepreferredPattern: LOINC code 88085-6
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.relatesTo:sliceTransformed.coderequiredFixed Value: transforms
Composition.relatesTo:sliceReplaced.coderequiredFixed Value: replaces
Composition.section:sliceRRSubjectSection.codeexamplePattern: LOINC code 88084-9
Composition.section:sliceEICRSection.codeexamplePattern: LOINC code 88082-3
Composition.section:sliceRRSummarySection.codeexamplePattern: LOINC code 55112-7

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition S0..*USPublicHealthCompositionReportability Response Composition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... sliceExtensionVersionNumber S1..1stringPublic Health Composition versionNumber
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... sliceExtensionInformationRecipient S1..*Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization)Reportability Response recipient(s)
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierPublic Health Composition identifier
... status ?!SΣ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ1..1CodeableConceptPublic Health Reportability Response Document
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88085-6
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... category Σ0..*CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ1..1Reference(US Public Health Patient)Patient
... encounter SΣ1..1Reference(eICR Encounter)eICR Encounter
... date SΣ1..1dateTimeComposition editing time
... author SΣ1..*Reference(Device | US Public Health Organization | US Core Practitioner Profile | US Public Health PractitionerRole)Author
... title SΣ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
... custodian SΣ1..1Reference(US Public Health Organization)Organization which maintains the composition
... Slices for relatesTo S0..*BackboneElementRelationships to other compositions/documents
Slice: Unordered, Open by value:code
.... relatesTo:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

..... target[x] 1..1Target of the relationship
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
.... relatesTo:sliceTransformed S0..1BackboneElementDocument or Composition that this Composition is transformed from
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: transforms
..... target[x] S1..1IdentifierIdentifier of the Document or Composition transformed
.... relatesTo:sliceReplaced S0..1BackboneElementDocument or Composition that this Composition replaces
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


Fixed Value: replaces
..... target[x] S1..1Identifier/Reference to the Document or Composition transformed
...... targetIdentifierIdentifier
...... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... Slices for section C0..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... section:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

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

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

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

..... section C0..*See section (Composition)Nested Section
.... section:sliceRRSubjectSection SC0..1BackboneElementReportability Response Subject Section
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code S1..1CodeableConceptReportable condition response information and summary Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88084-9
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text SC1..1NarrativeReportability Response Subject Section
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

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

..... section C0..*See section (Composition)Nested Section
.... section:sliceEICRSection SC1..1BackboneElementElectronic Initial Case Report Section
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionEICRProcessingStatus S1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension
..... extensionAlternatelyManuallyInitiatedEICR S0..1CodeableConceptAlternately or Manually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-initiation-type-extension
Binding: eICR Initiation (extensible): Initiation Types


..... extensionEICRReceiptTime S0..1dateTimeDate and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-receipt-time-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code S1..1CodeableConceptInitial case report processing information Document
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 88082-3
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text C0..1NarrativeText summary of the section, for human interpretation
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... Slices for entry SC0..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceEICRDocument SC0..*Reference(eICR Document Bundle | US Core DocumentReference Profile)Reference to eICR Document Bundle or eICR CDA document
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifiereICR Document Bundle identifier
....... display SΣ0..1stringFilename of eICR
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

..... section C0..*See section (Composition)Nested Section
.... section:sliceRRSummarySection SC0..1BackboneElementReportability Response Summary Section
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extensionRRPriority S1..1CodeableConceptRR Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: Reportability Priority (eCR) (extensible): Reportability Priority


..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringLabel for section (e.g. for ToC)
..... code S1..1CodeableConceptDocument summary
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 55112-7
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
..... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
..... text SC1..1NarrativeRR Summary Section narrative
..... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... Slices for entry SC1..*Reference(Resource)A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:sliceRRSummary SC1..1Reference(RR Summary)RR Summary
...... entry:sliceRRCondition SC1..*Reference(RR Relevant Reportable Condition Observation)Relevant Reportable Condition
..... emptyReason C0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
Composition.typepreferredPattern: LOINC code 88085-6
Composition.categoryexampleDocumentClassValueSet
Composition.confidentialityrequiredv3.ConfidentialityClassification
Composition.attester.moderequiredCompositionAttestationMode
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.relatesTo:sliceTransformed.coderequiredFixed Value: transforms
Composition.relatesTo:sliceReplaced.coderequiredFixed Value: replaces
Composition.event.codeexampleActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons
Composition.section:sliceRRSubjectSection.codeexamplePattern: LOINC code 88084-9
Composition.section:sliceRRSubjectSection.moderequiredListMode
Composition.section:sliceRRSubjectSection.orderedBypreferredListOrderCodes
Composition.section:sliceRRSubjectSection.emptyReasonpreferredListEmptyReasons
Composition.section:sliceEICRSection.codeexamplePattern: LOINC code 88082-3
Composition.section:sliceEICRSection.moderequiredListMode
Composition.section:sliceEICRSection.orderedBypreferredListOrderCodes
Composition.section:sliceEICRSection.entry:sliceEICRDocument.typeextensibleResourceType
Composition.section:sliceEICRSection.emptyReasonpreferredListEmptyReasons
Composition.section:sliceRRSummarySection.codeexamplePattern: LOINC code 55112-7
Composition.section:sliceRRSummarySection.moderequiredListMode
Composition.section:sliceRRSummarySection.orderedBypreferredListOrderCodes
Composition.section:sliceRRSummarySection.emptyReasonpreferredListEmptyReasons

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sliceRRSubjectSection, Composition.section:sliceEICRSection, Composition.section:sliceRRSummarySectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USPublicHealthComposition

Summary

Mandatory: 7 elements (8 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Composition.relatesTo is sliced based on the value of value:code
  • The element Composition.section is sliced based on the value of value:code
  • The element Composition.section.entry is sliced based on the value of profile:resolve()

 

Other representations of profile: CSV, Excel, Schematron