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
• XML
• JSON
• TTL

Resource Profile: Catalog 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:

• This Resource Profile is not used by any profiles in this Implementation Guide

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	The type of document - a Catalog Fixed Value: As shown
text		1..1	string	Plain text representation of the concept Fixed Value: Catalog
category		1..1	CodeableConcept	The Content of the section Binding: CatalogType (example): The type of catalog.
subject		0..0
date		1..1	dateTime	When the Catalog was created
section		0..*	BackboneElement	Composition is broken into sections
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	The type of document - a Catalog Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		0..0	Coding	Code defined by a terminology system
text		1..1	string	Plain text representation of the concept Fixed Value: Catalog
category	Σ	1..1	CodeableConcept	The Content of the section Binding: CatalogType (example): The type of catalog. ele-1: All FHIR elements must have a @value or children
date	Σ	1..1	dateTime	When the Catalog was created ele-1: All FHIR elements must have a @value or children
author	Σ	1..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the composition 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
section	C	0..*	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty 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
entry	C	0..*	Reference(Resource)	A reference to data that supports this section ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
Composition.type	preferred	Fixed Value: "Catalog" 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

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	The type of document - a Catalog Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		0..0	Coding	Code defined by a terminology system
text		1..1	string	Plain text representation of the concept Fixed Value: Catalog
category	Σ	1..1	CodeableConcept	The Content of the section Binding: CatalogType (example): The type of catalog.
encounter	Σ	0..1	Reference(Encounter)	Context of the Composition
date	Σ	1..1	dateTime	When the Catalog was created
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
author	Σ	1..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the composition
name	Σ	0..1	string	Name for this Composition (computer friendly)
title	Σ	1..1	string	Human Readable name/title
note		0..*	Annotation	For any additional notes
attester		0..*	BackboneElement	Attests to accuracy of composition
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	CodeableConcept	personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
time		0..1	dateTime	When the composition was attested
party		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)	Who attested the composition
custodian	Σ	0..1	Reference(Organization)	Organization which maintains the composition
relatesTo		0..*	RelatedArtifact	Relationships to other compositions/documents
event	Σ	0..*	BackboneElement	The clinical service(s) being documented
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	Σ	0..1	Period	The period covered by the documentation
detail	Σ	0..*	CodeableReference(Resource)	The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
section	C	0..*	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
title		0..1	string	Label for section (e.g. for ToC)
code		0..1	CodeableConcept	Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
author		0..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the section
focus		0..1	Reference(Resource)	Who/what the section is about, when it is not about the subject of composition
text	C	0..1	Narrative	Text summary of the section, for human interpretation
orderedBy		0..1	CodeableConcept	Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
emptyReason	C	0..1	CodeableConcept	Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
section		0..*	See section (Composition)	Nested Section
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	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	Fixed Value: "Catalog" 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: 3 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

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

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	The type of document - a Catalog Fixed Value: As shown
text		1..1	string	Plain text representation of the concept Fixed Value: Catalog
category		1..1	CodeableConcept	The Content of the section Binding: CatalogType (example): The type of catalog.
subject		0..0
date		1..1	dateTime	When the Catalog was created
section		0..*	BackboneElement	Composition is broken into sections
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	The type of document - a Catalog Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		0..0	Coding	Code defined by a terminology system
text		1..1	string	Plain text representation of the concept Fixed Value: Catalog
category	Σ	1..1	CodeableConcept	The Content of the section Binding: CatalogType (example): The type of catalog. ele-1: All FHIR elements must have a @value or children
date	Σ	1..1	dateTime	When the Catalog was created ele-1: All FHIR elements must have a @value or children
author	Σ	1..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the composition 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
section	C	0..*	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty 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
entry	C	0..*	Reference(Resource)	A reference to data that supports this section ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Composition.status	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard
Composition.type	preferred	Fixed Value: "Catalog" 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

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	The type of document - a Catalog Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		0..0	Coding	Code defined by a terminology system
text		1..1	string	Plain text representation of the concept Fixed Value: Catalog
category	Σ	1..1	CodeableConcept	The Content of the section Binding: CatalogType (example): The type of catalog.
encounter	Σ	0..1	Reference(Encounter)	Context of the Composition
date	Σ	1..1	dateTime	When the Catalog was created
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
author	Σ	1..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the composition
name	Σ	0..1	string	Name for this Composition (computer friendly)
title	Σ	1..1	string	Human Readable name/title
note		0..*	Annotation	For any additional notes
attester		0..*	BackboneElement	Attests to accuracy of composition
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	CodeableConcept	personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
time		0..1	dateTime	When the composition was attested
party		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)	Who attested the composition
custodian	Σ	0..1	Reference(Organization)	Organization which maintains the composition
relatesTo		0..*	RelatedArtifact	Relationships to other compositions/documents
event	Σ	0..*	BackboneElement	The clinical service(s) being documented
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	Σ	0..1	Period	The period covered by the documentation
detail	Σ	0..*	CodeableReference(Resource)	The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
section	C	0..*	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
title		0..1	string	Label for section (e.g. for ToC)
code		0..1	CodeableConcept	Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
author		0..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the section
focus		0..1	Reference(Resource)	Who/what the section is about, when it is not about the subject of composition
text	C	0..1	Narrative	Text summary of the section, for human interpretation
orderedBy		0..1	CodeableConcept	Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
emptyReason	C	0..1	CodeableConcept	Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
section		0..*	See section (Composition)	Nested Section
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	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	Fixed Value: "Catalog" 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: 3 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

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

Maturity: 2

Other representations of profile: CSV, Excel, Schematron