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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: CatalogHeader Profile

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.

Usage:

• Refer to this Resource Profile: Reference to a catalog
• Examples for this Resource Profile: Composition/example-device-catalog-header, Composition/example-lab-compendium-header and Composition/example-medication-catalog-header

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Composition

Name	Flags	Card.	Type	Description & Constraints
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
subject		0..*	Reference(Resource)	Plan or set of dispositions subject of the catalog
encounter		0..0
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
section		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Composition.category	example	CatalogType http://hl7.org/fhir/ValueSet/catalogType from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Composition		0..*	Composition	A set of resources composed into a single coherent clinical statement with clinical attestation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Kind of composition: a catalog Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children
text	Σ	1..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Fixed Value: Catalog
category	Σ	0..*	CodeableConcept	Kind of catalog Binding: CatalogType (example): Category of catalog content ele-1: All FHIR elements must have a @value or children
subject	Σ	0..*	Reference(Resource)	Plan or set of dispositions subject of the catalog ele-1: All FHIR elements must have a @value or children
date	Σ	1..1	dateTime	Catalog content last editing time ele-1: All FHIR elements must have a @value or children
author	Σ	1..*	Reference(Organization)	The organization authoring the catalog content ele-1: All FHIR elements must have a @value or children
title	Σ	1..1	string	Human Readable name/title ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:OtherTitle		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
attester		0..1	BackboneElement	Attests to accuracy of composition ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
mode		1..1	CodeableConcept	personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition. ele-1: All FHIR elements must have a @value or children
time		1..1	dateTime	When the composition was attested ele-1: All FHIR elements must have a @value or children
custodian	Σ	1..1	Reference(Organization)	Organization which maintains the composition ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.category	example	CatalogType http://hl7.org/fhir/ValueSet/catalogType from the FHIR Standard
Composition.attester.mode	preferred	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.category	example	CatalogType http://hl7.org/fhir/ValueSet/catalogType from the FHIR Standard
Composition.attester.mode	preferred	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard
Composition.event.detail	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.code	example	DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard
Composition.section.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
Composition.section.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard

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:

• http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
• http://hl7.org/fhir/StructureDefinition/translation

Maturity: 2

Differential View

This structure is derived from Composition

Name	Flags	Card.	Type	Description & Constraints
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
subject		0..*	Reference(Resource)	Plan or set of dispositions subject of the catalog
encounter		0..0
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
section		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Composition.category	example	CatalogType http://hl7.org/fhir/ValueSet/catalogType from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Composition		0..*	Composition	A set of resources composed into a single coherent clinical statement with clinical attestation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Kind of composition: a catalog Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children
text	Σ	1..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Fixed Value: Catalog
category	Σ	0..*	CodeableConcept	Kind of catalog Binding: CatalogType (example): Category of catalog content ele-1: All FHIR elements must have a @value or children
subject	Σ	0..*	Reference(Resource)	Plan or set of dispositions subject of the catalog ele-1: All FHIR elements must have a @value or children
date	Σ	1..1	dateTime	Catalog content last editing time ele-1: All FHIR elements must have a @value or children
author	Σ	1..*	Reference(Organization)	The organization authoring the catalog content ele-1: All FHIR elements must have a @value or children
title	Σ	1..1	string	Human Readable name/title ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:OtherTitle		0..*	(Complex)	Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
attester		0..1	BackboneElement	Attests to accuracy of composition ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
mode		1..1	CodeableConcept	personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition. ele-1: All FHIR elements must have a @value or children
time		1..1	dateTime	When the composition was attested ele-1: All FHIR elements must have a @value or children
custodian	Σ	1..1	Reference(Organization)	Organization which maintains the composition ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.category	example	CatalogType http://hl7.org/fhir/ValueSet/catalogType from the FHIR Standard
Composition.attester.mode	preferred	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard
Composition.category	example	CatalogType http://hl7.org/fhir/ValueSet/catalogType from the FHIR Standard
Composition.attester.mode	preferred	CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard
Composition.event.detail	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.code	example	DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard
Composition.section.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
Composition.section.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard

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:

• http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod
• http://hl7.org/fhir/StructureDefinition/translation

Maturity: 2

Other representations of profile: CSV, Excel, Schematron