Order Catalog Implementation Guide
1.0.0-ballot - CI Build
Order Catalog Implementation Guide
1.0.0-ballot - CI Build
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
| Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/Catalog | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: Catalog | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.6 | ||||
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 | ||||
| Path | Conformance | ValueSet | URI |
| Composition.category | example | CatalogTypehttp://hl7.org/fhir/ValueSet/catalogTypeFrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
| date |
Σ | 1..1 | dateTime | When the Catalog was created |
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition |
| title |
Σ | 1..1 | string | Human Readable name/title |
 section |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0From the FHIR Standard | |
| Composition.type | preferred | Fixed Value: "Catalog"http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | CatalogTypehttp://hl7.org/fhir/ValueSet/catalogTypeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| 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 Constraints: cmp-1, cmp-2 | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0From the FHIR Standard | |
| Composition.type | preferred | Fixed Value: "Catalog"http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | CatalogTypehttp://hl7.org/fhir/ValueSet/catalogTypeFrom the FHIR Standard | |
| Composition.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-modeFrom the FHIR Standard | |
| Composition.event.detail | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | |
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | |
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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: 3 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Maturity: 2
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| Composition.category | example | CatalogTypehttp://hl7.org/fhir/ValueSet/catalogTypeFrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
| date |
Σ | 1..1 | dateTime | When the Catalog was created |
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition |
| title |
Σ | 1..1 | string | Human Readable name/title |
| section |
C | 0..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0From the FHIR Standard | |
| Composition.type | preferred | Fixed Value: "Catalog"http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | CatalogTypehttp://hl7.org/fhir/ValueSet/catalogTypeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| 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 Constraints: cmp-1, cmp-2 | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0From the FHIR Standard | |
| Composition.type | preferred | Fixed Value: "Catalog"http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | CatalogTypehttp://hl7.org/fhir/ValueSet/catalogTypeFrom the FHIR Standard | |
| Composition.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-modeFrom the FHIR Standard | |
| Composition.event.detail | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | |
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | |
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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: 3 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Orders and Observations. Package hl7.fhir.uv.order-catalog#1.0.0-ballot based on FHIR 5.0.0. Generated 2025-06-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change