CH LAB-Order (R4)
3.0.0-ci-build - ci-build Switzerland flag

CH LAB-Order (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-lab-order/ and changes regularly. See the Directory of published versions

Resource Profile: CH LAB-Order Composition with Service Request

Official URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-order-composition-with-sr Version: 3.0.0-ci-build
Active as of 2019-01-30 Computable Name: ChLabOrderCompositionWithSR

Copyright/Legal: CC0-1.0

Definition for Composition resource in the context of CH LAB-Order with Service Request, parent is CHCoreComposition

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* CHCoreComposition CH LAB-Order Composition with ServiceRequest
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... category Σ 1..1 CodeableConcept Order Document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) Patient as the principle target of service request
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... date Σ 1..1 dateTime Composition editing time
... author SΣ 1..1 Reference(CH Core PractitionerRole) The person/organization responsible for the form content
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... title SΣ 1..1 string Meaningful title
... Slices for section SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:orderReferral SC 1..1 BackboneElement Contains the data that supports the order by ServiceRequest.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Laboratory Order by Service Request
..... code S 1..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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 721963009
....... display 1..1 string Representation defined by the system
Fixed Value: Order (record artifact)
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... Slices for entry SC 1..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC 1..* Reference(CH LAB-Order-SR) ServiceRequest
....... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... entry:DocumentReference SC 0..* Reference(CH Core DocumentReference) DocumentReference
....... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base required DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
Composition.category Base required DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
Composition.section:orderReferral.​code Base example Document Section Codes 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from CHCoreComposition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* CHCoreComposition CH LAB-Order Composition with ServiceRequest
... type 1..1 CodeableConcept Precise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category 1..1 CodeableConcept Order Document
Binding: DocumentEntry.classCode (required)
... subject S 1..1 Reference(CH Core Patient) Patient as the principle target of service request
... title S 1..1 string Meaningful title
... Slices for section S 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
.... section:orderReferral S 1..1 BackboneElement Contains the data that supports the order by ServiceRequest.
..... title S 1..1 string Laboratory Order by Service Request
..... code S 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 721963009
....... display 1..1 string Representation defined by the system
Fixed Value: Order (record artifact)
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... Slices for entry S 1..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest S 1..* Reference(CH LAB-Order-SR) ServiceRequest
....... reference S 1..1 string Literal reference, Relative, internal or absolute URL
...... entry:DocumentReference S 0..* Reference(CH Core DocumentReference) DocumentReference
....... reference S 1..1 string Literal reference, Relative, internal or absolute URL
..... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.type Base required DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
Composition.category Base required DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* CHCoreComposition CH LAB-Order Composition with ServiceRequest
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Precise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category Σ 1..1 CodeableConcept Order Document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) Patient as the principle target of service request
.... 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 SΣ 1..1 Reference(CH Core PractitionerRole) The person/organization responsible for the form content
.... 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 SΣ 1..1 string Meaningful 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 | CH Core 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 SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | CH Core 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... 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:orderReferral SC 1..1 BackboneElement Contains the data that supports the order by ServiceRequest.
Constraints: cmp-1, cmp-2
..... 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 S 1..1 string Laboratory Order by Service Request
..... code S 1..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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 721963009
....... display 1..1 string Representation defined by the system
Fixed Value: Order (record artifact)
....... 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 | CH Core 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 SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... Slices for entry SC 1..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC 1..* Reference(CH LAB-Order-SR) ServiceRequest
....... 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 SΣ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
...... entry:DocumentReference SC 0..* Reference(CH Core DocumentReference) DocumentReference
....... 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 SΣ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
..... 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

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base required DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
Composition.category Base required DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
Composition.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.author.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester.​party.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.custodian.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​entry:ServiceRequest.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​entry:DocumentReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from CHCoreComposition

Summary

Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.section
  • The element 1 is sliced based on the value of Composition.section.entry

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* CHCoreComposition CH LAB-Order Composition with ServiceRequest
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... category Σ 1..1 CodeableConcept Order Document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) Patient as the principle target of service request
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... date Σ 1..1 dateTime Composition editing time
... author SΣ 1..1 Reference(CH Core PractitionerRole) The person/organization responsible for the form content
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... title SΣ 1..1 string Meaningful title
... Slices for section SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:orderReferral SC 1..1 BackboneElement Contains the data that supports the order by ServiceRequest.
Constraints: cmp-1, cmp-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Laboratory Order by Service Request
..... code S 1..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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 721963009
....... display 1..1 string Representation defined by the system
Fixed Value: Order (record artifact)
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... Slices for entry SC 1..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC 1..* Reference(CH LAB-Order-SR) ServiceRequest
....... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... entry:DocumentReference SC 0..* Reference(CH Core DocumentReference) DocumentReference
....... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base required DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
Composition.category Base required DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
Composition.section:orderReferral.​code Base example Document Section Codes 📍4.0.1 FHIR Std.

Constraints

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

Differential View

This structure is derived from CHCoreComposition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* CHCoreComposition CH LAB-Order Composition with ServiceRequest
... type 1..1 CodeableConcept Precise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category 1..1 CodeableConcept Order Document
Binding: DocumentEntry.classCode (required)
... subject S 1..1 Reference(CH Core Patient) Patient as the principle target of service request
... title S 1..1 string Meaningful title
... Slices for section S 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
.... section:orderReferral S 1..1 BackboneElement Contains the data that supports the order by ServiceRequest.
..... title S 1..1 string Laboratory Order by Service Request
..... code S 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 721963009
....... display 1..1 string Representation defined by the system
Fixed Value: Order (record artifact)
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... Slices for entry S 1..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest S 1..* Reference(CH LAB-Order-SR) ServiceRequest
....... reference S 1..1 string Literal reference, Relative, internal or absolute URL
...... entry:DocumentReference S 0..* Reference(CH Core DocumentReference) DocumentReference
....... reference S 1..1 string Literal reference, Relative, internal or absolute URL
..... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.type Base required DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
Composition.category Base required DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* CHCoreComposition CH LAB-Order Composition with ServiceRequest
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Precise type of clinical document
Binding: DocumentEntry.typeCode (required)
... category Σ 1..1 CodeableConcept Order Document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) Patient as the principle target of service request
.... 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 SΣ 1..1 Reference(CH Core PractitionerRole) The person/organization responsible for the form content
.... 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 SΣ 1..1 string Meaningful 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 | CH Core 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 SC 1..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by value:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 0..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
..... author 0..* Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | CH Core 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... 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:orderReferral SC 1..1 BackboneElement Contains the data that supports the order by ServiceRequest.
Constraints: cmp-1, cmp-2
..... 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 S 1..1 string Laboratory Order by Service Request
..... code S 1..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://snomed.info/sct
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 721963009
....... display 1..1 string Representation defined by the system
Fixed Value: Order (record artifact)
....... 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 | CH Core 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 SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... Slices for entry SC 1..* Reference(Resource) A reference to data that supports this section
Slice: Unordered, Open by profile:resolve()
...... entry:ServiceRequest SC 1..* Reference(CH LAB-Order-SR) ServiceRequest
....... 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 SΣ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
...... entry:DocumentReference SC 0..* Reference(CH Core DocumentReference) DocumentReference
....... 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 SΣ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
..... 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

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base required DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
Composition.category Base required DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
Composition.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.author.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester.​party.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.custodian.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​entry:ServiceRequest.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​entry:DocumentReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Composition.section:orderReferral.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from CHCoreComposition

Summary

Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.section
  • The element 1 is sliced based on the value of Composition.section.entry

 

Other representations of profile: CSV, Excel, Schematron