Order Catalog Implementation Guide
1.0.0-ballot - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

Resource Profile: CatalogHeader Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogHeader Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: CatalogHeader
Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.7

This profile of Composition retains the elements and extensions needed to characterize a catalog of healthare products / services / knowledge artefacts, with a set of general properties (name, category, owner, …)

An instance of Composition conforming to this profile represents the general properties of a specific catalog of healthcare items (services/products/knowledge artefacts). Such a resource is referenced by the resources representing the individual items of the catalog.

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
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:ValidityPeriod S 0..1 Period Validity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... text Σ 1..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..* Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Catalog content last editing time
... author Σ 1..* Reference(Organization) The organization authoring the catalog content
... 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 0..1 BackboneElement Attests to accuracy of composition
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
.... time 1..1 dateTime When the composition was attested
... custodian Σ 1..1 Reference(Organization) Organization which maintains the composition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
Composition.category Base example Catalog Type 📦5.0.0 FHIR Std.
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 Content/Rules for all slices
.... extension:ValidityPeriod S 0..1 Period Validity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... type 1..1 CodeableConcept Kind of composition: a catalog
.... text 1..1 string Plain text representation of the concept
Fixed Value: Catalog
... category 0..* CodeableConcept Kind of catalog
Binding: CatalogType (example): Category of catalog content
... encounter 0..0 Context of the Composition
... date 1..1 dateTime Catalog content last editing time
... author 1..* Reference(Organization) The organization authoring the catalog content
... 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 0..1 BackboneElement Attests to accuracy of composition
.... time 1..1 dateTime When the composition was attested
... custodian 1..1 Reference(Organization) Organization which maintains the composition
... event 0..0 The clinical service(s) being documented
... section 0..0 Composition is broken into sections

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.category Base example Catalog Type 📦5.0.0 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 S 0..1 Period Validity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Version-independent identifier for the Composition
... version Σ 0..1 string An explicitly assigned identifer of a variation of the content in the Composition
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... id 0..1 id 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 Σ 1..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..* Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Catalog content last editing time
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Organization) The organization authoring the catalog content
... name Σ 0..1 string Name for this Composition (computer friendly)
... 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
... note 0..* Annotation For any additional notes
... attester 0..1 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 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 1..1 Reference(Organization) Organization which maintains the composition
... relatesTo 0..* RelatedArtifact Relationships to other compositions/documents

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base required All Languages 📍5.0.0 FHIR Std.
Composition.status Base required Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
Composition.category Base example Catalog Type 📦5.0.0 FHIR Std.
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
Composition.event.detail Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍5.0.0 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 2 elements(1 nested mandatory element)
Must-Support: 1 element
Fixed: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Maturity: 2

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
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:ValidityPeriod S 0..1 Period Validity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... text Σ 1..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..* Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Catalog content last editing time
... author Σ 1..* Reference(Organization) The organization authoring the catalog content
... 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 0..1 BackboneElement Attests to accuracy of composition
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
.... time 1..1 dateTime When the composition was attested
... custodian Σ 1..1 Reference(Organization) Organization which maintains the composition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
Composition.category Base example Catalog Type 📦5.0.0 FHIR Std.
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 Content/Rules for all slices
.... extension:ValidityPeriod S 0..1 Period Validity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... type 1..1 CodeableConcept Kind of composition: a catalog
.... text 1..1 string Plain text representation of the concept
Fixed Value: Catalog
... category 0..* CodeableConcept Kind of catalog
Binding: CatalogType (example): Category of catalog content
... encounter 0..0 Context of the Composition
... date 1..1 dateTime Catalog content last editing time
... author 1..* Reference(Organization) The organization authoring the catalog content
... 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 0..1 BackboneElement Attests to accuracy of composition
.... time 1..1 dateTime When the composition was attested
... custodian 1..1 Reference(Organization) Organization which maintains the composition
... event 0..0 The clinical service(s) being documented
... section 0..0 Composition is broken into sections

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.category Base example Catalog Type 📦5.0.0 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 S 0..1 Period Validity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Version-independent identifier for the Composition
... version Σ 0..1 string An explicitly assigned identifer of a variation of the content in the Composition
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
.... id 0..1 id 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 Σ 1..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..* Reference(Resource) Plan or set of dispositions subject of the catalog
... date Σ 1..1 dateTime Catalog content last editing time
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Organization) The organization authoring the catalog content
... name Σ 0..1 string Name for this Composition (computer friendly)
... 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
... note 0..* Annotation For any additional notes
... attester 0..1 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 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
.... time 1..1 dateTime When the composition was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 1..1 Reference(Organization) Organization which maintains the composition
... relatesTo 0..* RelatedArtifact Relationships to other compositions/documents

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base required All Languages 📍5.0.0 FHIR Std.
Composition.status Base required Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
Composition.category Base example Catalog Type 📦5.0.0 FHIR Std.
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
Composition.event.detail Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base example Document Section Codes 📍5.0.0 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 2 elements(1 nested mandatory element)
Must-Support: 1 element
Fixed: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron