CH ELM (R4)
1.7.0 - release Switzerland flag

This page is part of the Observations of notifiable communicable infectious diseases (v1.7.0: Release) based on FHIR (HL7® FHIR® Standard) 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.7.0
Active as of 2024-11-28 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 ChLabReportComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* ChLabReportComposition CH ELM Composition: Laboratory Report
This profile also imposes the profile Composition: Laboratory Report
... identifier 1..1 Identifier Persistent, unique identifier for the diagnostic report (UUID)
.... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value C 1..1 string The 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..1 code preliminary | final | amended | entered-in-error
Required Pattern: final
... subject 1..1 Reference(CH ELM Patient) Who and/or what the composition is about
... section 1..1 BackboneElement Composition is broken into sections
... Slices for section Content/Rules for all slices
.... section:lab-no-subsections 1..1 BackboneElement Variant 1: EU Laboratory Report section with entries and no sub-sections
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 ChElmCodeableConcept Concept - reference to a terminology or just text
Binding: CH ELM Lab Study Types (required)
..... entry 1..1 Reference(CH ELM Observation Results: Laboratory) A reference to data that supports this section
.... section:lab-subsections 0..0
.... section:annotations 0..1 BackboneElement Annotation comment

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
http://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-types
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* ChLabReportComposition CH ELM Composition: Laboratory Report
This profile also imposes the profile Composition: Laboratory Report
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... information-recipient 0..* (Complex) Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
.... basedOn-order-or-requisition 0..* (Complex) Document Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Reference(ServiceRequest) Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 0..1 Reference(CH LAB ServiceRequest: Laboratory Order) Value of extension
.... diagnosticReport-reference 0..1 (Complex) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference"
..... value[x] 1..1 Reference(CH LAB DiagnosticReport: Laboratory Report) Value of extension
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC 1..1 string The 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
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


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

... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


.... category:studyType 0..* CodeableConceptIPS The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConceptIPS The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles)
Binding: Laboratory Specialty (required)
... subject Σ 1..1 Reference(CH ELM Patient) Who and/or what the composition is about
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..1 Reference(CH ELM Organization: Author) Who and/or what authored the composition
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... title Σ 1..1 string Human Readable name/title
... Slices for section C 1..1 BackboneElement Composition is broken into sections
Slice: Unordered, Open by exists:$this.section, exists:$this.entry
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... section:lab-no-subsections C 1..1 BackboneElement Variant 1: EU Laboratory Report section with entries and no sub-sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 ChElmCodeableConcept Concept - reference to a terminology or just text
Binding: CH ELM Lab Study Types (required)
..... entry C 1..1 Reference(CH ELM Observation Results: Laboratory) A reference to data that supports this section
.... section:annotations C 0..1 BackboneElement Annotation comment
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... text C 1..1 Narrative Text summary of the section, for human interpretation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
http://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-types
from this IG
Composition.section:lab-subsections.section.codepreferredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
cmp-1errorComposition.section, Composition.section:lab-no-subsections, Composition.section:annotationsA 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-subsections, Composition.section:annotationsA 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 0..* ChLabReportComposition CH ELM Composition: Laboratory Report
This profile also imposes the profile Composition: Laboratory Report
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... information-recipient 0..* (Complex) Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
..... value[x] 0..1 Reference(CH LAB Practitioner | Device | CH LAB Patient | RelatedPerson | CH LAB PractitionerRole | CH Core Organization) Value of extension
.... basedOn-order-or-requisition 0..* (Complex) Document Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Reference(ServiceRequest) Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 0..1 Reference(CH LAB ServiceRequest: Laboratory Order) Value of extension
.... diagnosticReport-reference 0..1 (Complex) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference"
..... value[x] 1..1 Reference(CH LAB DiagnosticReport: Laboratory Report) Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Persistent, unique identifier for the diagnostic report (UUID)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC 1..1 string The 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..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


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

... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


.... category:studyType 0..* CodeableConceptIPS The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConceptIPS The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles)
Binding: Laboratory Specialty (required)
... subject Σ 1..1 Reference(CH ELM Patient) Who and/or what the composition is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(CH Core Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..1 Reference(CH ELM Organization: Author) Who and/or what authored the composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... title Σ 1..1 string Human Readable name/title
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) Who attested the composition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... custodian Σ 0..1 Reference(CH Core Organization) Organization which maintains the composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(CH Core Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section C 1..1 BackboneElement Composition is broken into sections
Slice: Unordered, Open by exists:$this.section, exists:$this.entry
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
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..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text C 0..1 Narrative Text summary of the section, for human interpretation
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

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

..... section C 0..* See section (Composition) Nested Section
.... section:lab-no-subsections C 1..1 BackboneElement Variant 1: EU Laboratory Report section with entries and no sub-sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 ChElmCodeableConcept Concept - reference to a terminology or just text
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..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text C 0..1 Narrative Text summary of the section, for human interpretation.
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... entry C 1..1 Reference(CH ELM Observation Results: Laboratory) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:annotations C 0..1 BackboneElement Annotation comment
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48767-8
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text C 1..1 Narrative Text summary of the section, for human interpretation
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.extension:diagnosticReport-reference.value[x].typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Composition.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
Composition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.attester.party.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.custodian.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
http://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-types
from this IG
Composition.section:lab-no-subsections.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:lab-no-subsections.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:lab-no-subsections.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:lab-subsections.codepreferredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.section:lab-subsections.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:lab-subsections.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:lab-subsections.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:lab-subsections.section.codepreferredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.section:lab-subsections.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:lab-subsections.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:lab-subsections.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:annotations.codeexamplePattern: LOINC Code 48767-8
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:annotations.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:annotations.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:annotations.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
cmp-1errorComposition.section, Composition.section:lab-no-subsections, Composition.section:annotationsA 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-subsections, Composition.section:annotationsA 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()

Differential View

This structure is derived from ChLabReportComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* ChLabReportComposition CH ELM Composition: Laboratory Report
This profile also imposes the profile Composition: Laboratory Report
... identifier 1..1 Identifier Persistent, unique identifier for the diagnostic report (UUID)
.... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value C 1..1 string The 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..1 code preliminary | final | amended | entered-in-error
Required Pattern: final
... subject 1..1 Reference(CH ELM Patient) Who and/or what the composition is about
... section 1..1 BackboneElement Composition is broken into sections
... Slices for section Content/Rules for all slices
.... section:lab-no-subsections 1..1 BackboneElement Variant 1: EU Laboratory Report section with entries and no sub-sections
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 ChElmCodeableConcept Concept - reference to a terminology or just text
Binding: CH ELM Lab Study Types (required)
..... entry 1..1 Reference(CH ELM Observation Results: Laboratory) A reference to data that supports this section
.... section:lab-subsections 0..0
.... section:annotations 0..1 BackboneElement Annotation comment

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
http://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-types
from this IG

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 0..* ChLabReportComposition CH ELM Composition: Laboratory Report
This profile also imposes the profile Composition: Laboratory Report
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... information-recipient 0..* (Complex) Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
.... basedOn-order-or-requisition 0..* (Complex) Document Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Reference(ServiceRequest) Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 0..1 Reference(CH LAB ServiceRequest: Laboratory Order) Value of extension
.... diagnosticReport-reference 0..1 (Complex) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference"
..... value[x] 1..1 Reference(CH LAB DiagnosticReport: Laboratory Report) Value of extension
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC 1..1 string The 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
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


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

... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


.... category:studyType 0..* CodeableConceptIPS The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConceptIPS The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles)
Binding: Laboratory Specialty (required)
... subject Σ 1..1 Reference(CH ELM Patient) Who and/or what the composition is about
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..1 Reference(CH ELM Organization: Author) Who and/or what authored the composition
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... title Σ 1..1 string Human Readable name/title
... Slices for section C 1..1 BackboneElement Composition is broken into sections
Slice: Unordered, Open by exists:$this.section, exists:$this.entry
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... section:lab-no-subsections C 1..1 BackboneElement Variant 1: EU Laboratory Report section with entries and no sub-sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 ChElmCodeableConcept Concept - reference to a terminology or just text
Binding: CH ELM Lab Study Types (required)
..... entry C 1..1 Reference(CH ELM Observation Results: Laboratory) A reference to data that supports this section
.... section:annotations C 0..1 BackboneElement Annotation comment
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... text C 1..1 Narrative Text summary of the section, for human interpretation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
http://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-types
from this IG
Composition.section:lab-subsections.section.codepreferredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
cmp-1errorComposition.section, Composition.section:lab-no-subsections, Composition.section:annotationsA 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-subsections, Composition.section:annotationsA 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 0..* ChLabReportComposition CH ELM Composition: Laboratory Report
This profile also imposes the profile Composition: Laboratory Report
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... information-recipient 0..* (Complex) Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
..... value[x] 0..1 Reference(CH LAB Practitioner | Device | CH LAB Patient | RelatedPerson | CH LAB PractitionerRole | CH Core Organization) Value of extension
.... basedOn-order-or-requisition 0..* (Complex) Document Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Reference(ServiceRequest) Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 0..1 Reference(CH LAB ServiceRequest: Laboratory Order) Value of extension
.... diagnosticReport-reference 0..1 (Complex) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference"
..... value[x] 1..1 Reference(CH LAB DiagnosticReport: Laboratory Report) Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Persistent, unique identifier for the diagnostic report (UUID)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value ΣC 1..1 string The 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..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


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

... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


.... category:studyType 0..* CodeableConceptIPS The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConceptIPS The way of grouping of the test results into clinically meaningful groups (e.g. liver test; minerals; glucose profiles)
Binding: Laboratory Specialty (required)
... subject Σ 1..1 Reference(CH ELM Patient) Who and/or what the composition is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(CH Core Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..1 Reference(CH ELM Organization: Author) Who and/or what authored the composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... title Σ 1..1 string Human Readable name/title
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.

... attester 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) Who attested the composition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... custodian Σ 0..1 Reference(CH Core Organization) Organization which maintains the composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(CH Core Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section C 1..1 BackboneElement Composition is broken into sections
Slice: Unordered, Open by exists:$this.section, exists:$this.entry
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
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..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text C 0..1 Narrative Text summary of the section, for human interpretation
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

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

..... section C 0..* See section (Composition) Nested Section
.... section:lab-no-subsections C 1..1 BackboneElement Variant 1: EU Laboratory Report section with entries and no sub-sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Label for section (e.g. for ToC)
..... code 1..1 ChElmCodeableConcept Concept - reference to a terminology or just text
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..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text C 0..1 Narrative Text summary of the section, for human interpretation.
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... entry C 1..1 Reference(CH ELM Observation Results: Laboratory) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:annotations C 0..1 BackboneElement Annotation comment
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48767-8
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text C 1..1 Narrative Text summary of the section, for human interpretation
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

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

..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Composition.extension:diagnosticReport-reference.value[x].typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Composition.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Composition.statusrequiredPattern: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
Composition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.attester.party.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.custodian.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:lab-no-subsections.coderequiredChElmLabStudyTypes
http://fhir.ch/ig/ch-elm/ValueSet/ch-elm-lab-study-types
from this IG
Composition.section:lab-no-subsections.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:lab-no-subsections.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:lab-no-subsections.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:lab-subsections.codepreferredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.section:lab-subsections.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:lab-subsections.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:lab-subsections.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:lab-subsections.section.codepreferredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
Composition.section:lab-subsections.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:lab-subsections.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:lab-subsections.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:annotations.codeexamplePattern: LOINC Code 48767-8
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:annotations.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:annotations.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:annotations.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-elm-doc-identifiererrorComposition.identifier.valueThe identifier must be an UUID.
: startsWith('urn:uuid:')
cmp-1errorComposition.section, Composition.section:lab-no-subsections, Composition.section:annotationsA 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-subsections, Composition.section:annotationsA 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()

 

Other representations of profile: CSV, Excel, Schematron