Order Catalog Implementation Guide
current - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). 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: current
Draft as of 2023-01-08 Computable Name: CatalogHeader

This profile of Compositions 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.

Usage:

Formal Views of Profile Content

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

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ValidityPeriod S0..1PeriodValidity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... type 1..1CodeableConceptKind of composition: a catalog
.... text 1..1stringPlain text representation of the concept
Fixed Value: Catalog
... subject 0..*Reference(Resource)Plan or set of dispositions subject of the catalog
... encounter 0..0
... date 1..1dateTimeCatalog content last editing time
... author 1..*Reference(Organization)The organization authoring the catalog content
... title
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 0..1BackboneElementAttests to accuracy of composition
.... time 1..1dateTimeWhen the composition was attested
... custodian 1..1Reference(Organization)Organization which maintains the composition
... event 0..0
... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Composition.categoryexampleCatalogType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ValidityPeriod S0..1PeriodValidity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... status ?!Σ1..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptKind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... text Σ1..1stringPlain text representation of the concept
Fixed Value: Catalog
... category Σ1..*CodeableConceptKind of catalog
Binding: CatalogType (example): Category of catalog content


... subject Σ0..*Reference(Resource)Plan or set of dispositions subject of the catalog
... date Σ1..1dateTimeCatalog content last editing time
... author Σ1..*Reference(Organization)The organization authoring the catalog content
... title Σ1..1stringHuman Readable name/title
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 0..1BackboneElementAttests to accuracy of composition
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.

.... time 1..1dateTimeWhen the composition was attested
... custodian Σ1..1Reference(Organization)Organization which maintains the composition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Composition.statusrequiredCompositionStatus
Composition.typepreferredFHIRDocumentTypeCodes
Composition.categoryexampleCatalogType
Composition.attester.modepreferredCompositionAttestationMode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ValidityPeriod S0..1PeriodValidity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierVersion-independent identifier for the Composition
... version Σ0..1stringAn explicitly assigned identifer of a variation of the content in the Composition
... status ?!Σ1..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptKind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ1..1stringPlain text representation of the concept
Fixed Value: Catalog
... category Σ1..*CodeableConceptKind of catalog
Binding: CatalogType (example): Category of catalog content


... subject Σ0..*Reference(Resource)Plan or set of dispositions subject of the catalog
... date Σ1..1dateTimeCatalog content last editing time
... useContext Σ0..*UsageContextThe context that the content is intended to support
... author Σ1..*Reference(Organization)The organization authoring the catalog content
... name Σ0..1stringName for this Composition (computer friendly)
... title Σ1..1stringHuman Readable name/title
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... note 0..*AnnotationFor any additional notes
... attester 0..1BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.

.... time 1..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
... custodian Σ1..1Reference(Organization)Organization which maintains the composition
... relatesTo 0..*RelatedArtifactRelationships to other compositions/documents

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
Composition.typepreferredFHIRDocumentTypeCodes
Composition.categoryexampleCatalogType
Composition.attester.modepreferredCompositionAttestationMode
Composition.event.codeexampleActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 1 element
Fixed Value: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ValidityPeriod S0..1PeriodValidity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... type 1..1CodeableConceptKind of composition: a catalog
.... text 1..1stringPlain text representation of the concept
Fixed Value: Catalog
... subject 0..*Reference(Resource)Plan or set of dispositions subject of the catalog
... encounter 0..0
... date 1..1dateTimeCatalog content last editing time
... author 1..*Reference(Organization)The organization authoring the catalog content
... title
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 0..1BackboneElementAttests to accuracy of composition
.... time 1..1dateTimeWhen the composition was attested
... custodian 1..1Reference(Organization)Organization which maintains the composition
... event 0..0
... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Composition.categoryexampleCatalogType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ValidityPeriod S0..1PeriodValidity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... status ?!Σ1..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptKind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... text Σ1..1stringPlain text representation of the concept
Fixed Value: Catalog
... category Σ1..*CodeableConceptKind of catalog
Binding: CatalogType (example): Category of catalog content


... subject Σ0..*Reference(Resource)Plan or set of dispositions subject of the catalog
... date Σ1..1dateTimeCatalog content last editing time
... author Σ1..*Reference(Organization)The organization authoring the catalog content
... title Σ1..1stringHuman Readable name/title
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... attester 0..1BackboneElementAttests to accuracy of composition
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.

.... time 1..1dateTimeWhen the composition was attested
... custodian Σ1..1Reference(Organization)Organization which maintains the composition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Composition.statusrequiredCompositionStatus
Composition.typepreferredFHIRDocumentTypeCodes
Composition.categoryexampleCatalogType
Composition.attester.modepreferredCompositionAttestationMode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCompositionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*CompositionA set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ValidityPeriod S0..1PeriodValidity Period
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierVersion-independent identifier for the Composition
... version Σ0..1stringAn explicitly assigned identifer of a variation of the content in the Composition
... status ?!Σ1..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type Σ1..1CodeableConceptKind of composition: a catalog
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ1..1stringPlain text representation of the concept
Fixed Value: Catalog
... category Σ1..*CodeableConceptKind of catalog
Binding: CatalogType (example): Category of catalog content


... subject Σ0..*Reference(Resource)Plan or set of dispositions subject of the catalog
... date Σ1..1dateTimeCatalog content last editing time
... useContext Σ0..*UsageContextThe context that the content is intended to support
... author Σ1..*Reference(Organization)The organization authoring the catalog content
... name Σ0..1stringName for this Composition (computer friendly)
... title Σ1..1stringHuman Readable name/title
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... OtherTitle 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... note 0..*AnnotationFor any additional notes
... attester 0..1BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.

.... time 1..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
... custodian Σ1..1Reference(Organization)Organization which maintains the composition
... relatesTo 0..*RelatedArtifactRelationships to other compositions/documents

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Composition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
Composition.typepreferredFHIRDocumentTypeCodes
Composition.categoryexampleCatalogType
Composition.attester.modepreferredCompositionAttestationMode
Composition.event.codeexampleActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 1 element
Fixed Value: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron