CH ELM (R4)
1.0.0-trialuse - trial-use Switzerland flag

This page is part of the Observations of notifiable communicable infectious diseases (v1.0.0-trialuse: STU 1 Draft) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH ELM Composition: Laboratory Report

Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-composition Version: 1.0.0-trialuse
Draft as of 2023-09-13 Computable Name: ChElmComposition

Copyright/Legal: CC0-1.0

This CH ELM base profile constrains the Composition resource for the purpose of laboratory test reports.

Usage:

Formal Views of Profile Content

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

This structure is derived from ChLabComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*ChLabCompositionCH ELM Composition: Laboratory Report
... identifier 1..1IdentifierPersistent, unique identifier for the document (UUID)
.... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value C1..1stringThe value that is unique
ch-elm-doc-identifier: The identifier must be an UUID.
Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f
... status 1..1codepreliminary | final | amended | entered-in-error
Required Pattern: final
... subject 1..1Reference(CH ELM Patient)Who and/or what the composition is about
... Slices for section 1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by exists:$this.section, type:$this.entry.resolve(), pattern:$this.code
.... section:All Slices Content/Rules for all slices
..... title 1..1stringLabel for section (e.g. for ToC)
..... code 1..1ChElmCodeableConceptConcept - reference to a terminology or just text
.... section:lab-no-subsections 1..1BackboneElementComposition is broken into sections
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: CH ELM Lab Study Types (required)
..... entry 1..1Reference(CH ELM Observation Results: Laboratory)A reference to data that supports this section
..... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C0..*ChLabCompositionCH ELM Composition: Laboratory Report
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierPersistent, unique identifier for the document (UUID)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
ch-elm-doc-identifier: The identifier must be an UUID.
Example General: 123456
Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 11502-2
... subject Σ1..1Reference(CH ELM Patient)Who and/or what the composition is about
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... date Σ1..1dateTimeComposition editing time
... author Σ1..1Reference(CH ELM Organization: Author)Who and/or what authored the composition
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... title Σ1..1stringHuman Readable name/title
... Slices for section C1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by exists:$this.section, type:$this.entry.resolve(), pattern:$this.code
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 1..1stringLabel for section (e.g. for ToC)
..... code 1..1ChElmCodeableConceptConcept - reference to a terminology or just text
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... section:lab-no-subsections C1..1BackboneElementComposition is broken into sections
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: CH ELM Lab Study Types (required)
..... entry C1..1Reference(CH ELM Observation Results: Laboratory)A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.identifier.userequiredIdentifierUse
Composition.statusrequiredPattern: final
Composition.typepreferredPattern: LOINC code 11502-2
Composition.section.codeexampleDocumentSectionCodes
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
ch-lab-comp1warningCompositionThe resource should be conform to the corresponding EU LAB profile
: conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab')
cmp-1errorComposition.section, Composition.section:lab-no-subsectionsA 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:lab-no-subsectionsA 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 C0..*ChLabCompositionCH ELM Composition: Laboratory Report
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierPersistent, unique identifier for the document (UUID)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
ch-elm-doc-identifier: The identifier must be an UUID.
Example General: 123456
Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


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


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... 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: 11502-2
..... 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.



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://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 4241000179101
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject Σ1..1Reference(CH ELM Patient)Who and/or what the composition is about
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(CH Core Encounter)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author Σ1..1Reference(CH ELM Organization: Author)Who and/or what authored the composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... title Σ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(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who attested the composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... custodian Σ0..1Reference(CH Core Organization)Organization which maintains the composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(CH Core 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 C1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by exists:$this.section, type:$this.entry.resolve(), pattern:$this.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 1..1stringLabel for section (e.g. for ToC)
..... code 1..1ChElmCodeableConceptConcept - reference to a terminology or just text
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core 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:lab-no-subsections C1..1BackboneElementComposition is broken into sections
..... 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: CH ELM Lab Study Types (required)
..... author 0..*Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core 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 C1..1Reference(CH ELM Observation Results: Laboratory)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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Composition.identifier.userequiredIdentifierUse
Composition.identifier.typeextensibleIdentifier Type Codes
Composition.statusrequiredPattern: final
Composition.typepreferredPattern: LOINC code 11502-2
Composition.categoryexamplePattern: SNOMED CT code 4241000179101
Composition.subject.typeextensibleResourceType
Composition.author.typeextensibleResourceType
Composition.confidentialityrequiredv3.ConfidentialityClassification
Composition.attester.moderequiredCompositionAttestationMode
Composition.attester.party.typeextensibleResourceType
Composition.custodian.typeextensibleResourceType
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.event.codeexampleActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
Composition.section:lab-no-subsections.moderequiredListMode
Composition.section:lab-no-subsections.orderedBypreferredListOrderCodes
Composition.section:lab-no-subsections.emptyReasonpreferredListEmptyReasons

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
ch-lab-comp1warningCompositionThe resource should be conform to the corresponding EU LAB profile
: conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab')
cmp-1errorComposition.section, Composition.section:lab-no-subsectionsA 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:lab-no-subsectionsA 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 ChLabComposition

Summary

Mandatory: 9 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.section is sliced based on the values of exists:$this.section, type:$this.entry.resolve(), pattern:$this.code

Differential View

This structure is derived from ChLabComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*ChLabCompositionCH ELM Composition: Laboratory Report
... identifier 1..1IdentifierPersistent, unique identifier for the document (UUID)
.... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value C1..1stringThe value that is unique
ch-elm-doc-identifier: The identifier must be an UUID.
Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f
... status 1..1codepreliminary | final | amended | entered-in-error
Required Pattern: final
... subject 1..1Reference(CH ELM Patient)Who and/or what the composition is about
... Slices for section 1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by exists:$this.section, type:$this.entry.resolve(), pattern:$this.code
.... section:All Slices Content/Rules for all slices
..... title 1..1stringLabel for section (e.g. for ToC)
..... code 1..1ChElmCodeableConceptConcept - reference to a terminology or just text
.... section:lab-no-subsections 1..1BackboneElementComposition is broken into sections
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: CH ELM Lab Study Types (required)
..... entry 1..1Reference(CH ELM Observation Results: Laboratory)A reference to data that supports this section
..... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition C0..*ChLabCompositionCH ELM Composition: Laboratory Report
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierPersistent, unique identifier for the document (UUID)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
ch-elm-doc-identifier: The identifier must be an UUID.
Example General: 123456
Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 11502-2
... subject Σ1..1Reference(CH ELM Patient)Who and/or what the composition is about
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... date Σ1..1dateTimeComposition editing time
... author Σ1..1Reference(CH ELM Organization: Author)Who and/or what authored the composition
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... title Σ1..1stringHuman Readable name/title
... Slices for section C1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by exists:$this.section, type:$this.entry.resolve(), pattern:$this.code
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 1..1stringLabel for section (e.g. for ToC)
..... code 1..1ChElmCodeableConceptConcept - reference to a terminology or just text
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... section:lab-no-subsections C1..1BackboneElementComposition is broken into sections
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptClassification of section (recommended)
Binding: CH ELM Lab Study Types (required)
..... entry C1..1Reference(CH ELM Observation Results: Laboratory)A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.identifier.userequiredIdentifierUse
Composition.statusrequiredPattern: final
Composition.typepreferredPattern: LOINC code 11502-2
Composition.section.codeexampleDocumentSectionCodes
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
ch-lab-comp1warningCompositionThe resource should be conform to the corresponding EU LAB profile
: conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab')
cmp-1errorComposition.section, Composition.section:lab-no-subsectionsA 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:lab-no-subsectionsA 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 C0..*ChLabCompositionCH ELM Composition: Laboratory Report
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierPersistent, unique identifier for the document (UUID)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
ch-elm-doc-identifier: The identifier must be an UUID.
Example General: 123456
Example CH ELM: urn:uuid:d494503a-7bef-4551-853c-f3dced2c518f
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


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


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... 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: 11502-2
..... 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.



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://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 4241000179101
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject Σ1..1Reference(CH ELM Patient)Who and/or what the composition is about
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(CH Core Encounter)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author Σ1..1Reference(CH ELM Organization: Author)Who and/or what authored the composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... title Σ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(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who attested the composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... custodian Σ0..1Reference(CH Core Organization)Organization which maintains the composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..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..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(CH Core 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 C1..*BackboneElementComposition is broken into sections
Slice: Unordered, Open by exists:$this.section, type:$this.entry.resolve(), pattern:$this.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 1..1stringLabel for section (e.g. for ToC)
..... code 1..1ChElmCodeableConceptConcept - reference to a terminology or just text
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

..... author 0..*Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core 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:lab-no-subsections C1..1BackboneElementComposition is broken into sections
..... 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: CH ELM Lab Study Types (required)
..... author 0..*Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core 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 C1..1Reference(CH ELM Observation Results: Laboratory)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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Composition.identifier.userequiredIdentifierUse
Composition.identifier.typeextensibleIdentifier Type Codes
Composition.statusrequiredPattern: final
Composition.typepreferredPattern: LOINC code 11502-2
Composition.categoryexamplePattern: SNOMED CT code 4241000179101
Composition.subject.typeextensibleResourceType
Composition.author.typeextensibleResourceType
Composition.confidentialityrequiredv3.ConfidentialityClassification
Composition.attester.moderequiredCompositionAttestationMode
Composition.attester.party.typeextensibleResourceType
Composition.custodian.typeextensibleResourceType
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.event.codeexampleActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
Composition.section:lab-no-subsections.moderequiredListMode
Composition.section:lab-no-subsections.orderedBypreferredListOrderCodes
Composition.section:lab-no-subsections.emptyReasonpreferredListEmptyReasons

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
ch-lab-comp1warningCompositionThe resource should be conform to the corresponding EU LAB profile
: conformsTo('http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab')
cmp-1errorComposition.section, Composition.section:lab-no-subsectionsA 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:lab-no-subsectionsA 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 ChLabComposition

Summary

Mandatory: 9 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.section is sliced based on the values of exists:$this.section, type:$this.entry.resolve(), pattern:$this.code

 

Other representations of profile: CSV, Excel, Schematron