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 Catalog Header (R4)

Official URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-catalog-header-r4 Version: 3.0.0-ci-build
Active as of 2025-10-28 Computable Name: ChLabCatalogHeaderR4

Copyright/Legal: CC0-1.0

Composition header for laboratory catalogs (R4-compatible adaptation of the HL7 Order Catalog CatalogHeader profile). This profile defines the structure of the catalog metadata and includes the validity period extension.

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..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validityPeriod 0..1 Period Optional Extensions Element
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-validity-period
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 CodeableConcept Type of composition – fixed to 'Catalog'
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... text Σ 0..1 string Plain text representation of the concept
Fixed Value: Catalog
... category Σ 0..* CodeableConcept Kind of catalog
Binding: CatalogType (example): Category of catalog content
... subject Σ 0..1 Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Date when the catalog was published or last updated
... author Σ 1..* Reference(Organization) The organization that authored the catalog
... title Σ 1..1 string Human Readable name/title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherTitle 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 1..* BackboneElement Attesters validating the catalog
.... 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.
Required Pattern: official
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Organization) Who attested the composition
... custodian Σ 1..1 Reference(Organization) The organization responsible for maintaining the catalog

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📦4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example CatalogType 📦4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validityPeriod 0..1 Period Optional Extensions Element
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-validity-period
... status 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type 1..1 CodeableConcept Type of composition – fixed to 'Catalog'
.... text 0..1 string Plain text representation of the concept
Fixed Value: Catalog
... subject 0..1 Reference(Resource) Plan or set of dispositions subject of the catalog
... encounter 0..0
... date 1..1 dateTime Date when the catalog was published or last updated
... author 1..* Reference(Organization) The organization that authored the catalog
... title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherTitle 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 1..* BackboneElement Attesters validating the catalog
.... mode 1..1 code personal | professional | legal | official
Required Pattern: official
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Organization) Who attested the composition
... custodian 1..1 Reference(Organization) The organization responsible for maintaining the catalog
... event 0..0
... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📦4.0.1 FHIR Std.
Composition.category Base example CatalogType 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validityPeriod 0..1 Period Optional Extensions Element
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-validity-period
... 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)
... type Σ 1..1 CodeableConcept Type of composition – fixed to 'Catalog'
Binding: FHIRDocumentTypeCodes (preferred): Type of a 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
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
Fixed Value: Catalog
... category Σ 0..* CodeableConcept Kind of catalog
Binding: CatalogType (example): Category of catalog content
... subject Σ 0..1 Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Date when the catalog was published or last updated
... author Σ 1..* Reference(Organization) The organization that authored the catalog
... title Σ 1..1 string Human Readable name/title
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherTitle 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 string Primitive value for string
Max Length:1048576
... 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 1..* BackboneElement Attesters validating the catalog
.... 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.
Required Pattern: official
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Organization) Who attested the composition
... custodian Σ 1..1 Reference(Organization) The organization responsible for maintaining the catalog
... 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(Composition)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📦4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example CatalogType 📦4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.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.

Constraints

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

Summary

Mandatory: 3 elements
Fixed: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validityPeriod 0..1 Period Optional Extensions Element
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-validity-period
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 CodeableConcept Type of composition – fixed to 'Catalog'
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... text Σ 0..1 string Plain text representation of the concept
Fixed Value: Catalog
... category Σ 0..* CodeableConcept Kind of catalog
Binding: CatalogType (example): Category of catalog content
... subject Σ 0..1 Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Date when the catalog was published or last updated
... author Σ 1..* Reference(Organization) The organization that authored the catalog
... title Σ 1..1 string Human Readable name/title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherTitle 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 1..* BackboneElement Attesters validating the catalog
.... 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.
Required Pattern: official
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Organization) Who attested the composition
... custodian Σ 1..1 Reference(Organization) The organization responsible for maintaining the catalog

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📦4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example CatalogType 📦4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validityPeriod 0..1 Period Optional Extensions Element
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-validity-period
... status 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type 1..1 CodeableConcept Type of composition – fixed to 'Catalog'
.... text 0..1 string Plain text representation of the concept
Fixed Value: Catalog
... subject 0..1 Reference(Resource) Plan or set of dispositions subject of the catalog
... encounter 0..0
... date 1..1 dateTime Date when the catalog was published or last updated
... author 1..* Reference(Organization) The organization that authored the catalog
... title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherTitle 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 1..* BackboneElement Attesters validating the catalog
.... mode 1..1 code personal | professional | legal | official
Required Pattern: official
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Organization) Who attested the composition
... custodian 1..1 Reference(Organization) The organization responsible for maintaining the catalog
... event 0..0
... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📦4.0.1 FHIR Std.
Composition.category Base example CatalogType 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validityPeriod 0..1 Period Optional Extensions Element
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-validity-period
... 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)
... type Σ 1..1 CodeableConcept Type of composition – fixed to 'Catalog'
Binding: FHIRDocumentTypeCodes (preferred): Type of a 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
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
Fixed Value: Catalog
... category Σ 0..* CodeableConcept Kind of catalog
Binding: CatalogType (example): Category of catalog content
... subject Σ 0..1 Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Date when the catalog was published or last updated
... author Σ 1..* Reference(Organization) The organization that authored the catalog
... title Σ 1..1 string Human Readable name/title
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherTitle 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 string Primitive value for string
Max Length:1048576
... 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 1..* BackboneElement Attesters validating the catalog
.... 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.
Required Pattern: official
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Organization) Who attested the composition
... custodian Σ 1..1 Reference(Organization) The organization responsible for maintaining the catalog
... 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(Composition)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📦4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example CatalogType 📦4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.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.

Constraints

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

Summary

Mandatory: 3 elements
Fixed: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron