Order Catalog Implementation Guide
0.1.0 - STU Ballot 1
Order Catalog Implementation Guide
0.1.0 - STU Ballot 1
This page is part of the Order Catalog Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
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, …)
The official URL for this profile is:
http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogHeader
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
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 | |
  extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 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 | 0..1 | string | Plain text representation of the concept Fixed Value: Catalog | |
| category | 0..* | CodeableConcept | Kind of catalog Binding: CatalogType (example) | |
| subject | 0..0 | |||
| encounter | 0..0 | |||
| date | 1..1 | dateTime | Catalog content last editing time | |
 author | 1..* | Reference(Organization) | The organization authoring the catalog content | |
| title | ||||
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| translation | 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 | |
| relatesTo | ||||
| code | 1..1 | code | addendum | |
| event | 0..0 | |||
| section | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ValidityPeriod | SI | 0..1 | Period | Validity Period URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Version-independent identifier for the Composition |
| status | ?!ΣI | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | ΣI | 1..1 | CodeableConcept | Kind of composition: a catalog Binding: FHIRDocumentTypeCodes (preferred) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Catalog |
| category | ΣI | 0..* | CodeableConcept | Kind of catalog Binding: CatalogType (example) |
| date | ΣI | 1..1 | dateTime | Catalog content last editing time |
| author | ΣI | 1..* | Reference(Organization) | The organization authoring the catalog content |
| title | ΣI | 1..1 | string | Human Readable name/title |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| confidentiality | ΣI | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required) |
| attester | I | 0..1 | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | I | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | I | 1..1 | dateTime | When the composition was attested |
| party | I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition |
| custodian | ΣI | 1..1 | Reference(Organization) | Organization which maintains the composition |
 relatesTo | I | 0..* | BackboneElement | Relationships to other compositions/documents |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 1..1 | code | addendum Binding: DocumentRelationshipType (required) |
 target[x] | I | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation |
| ValidityPeriod | I | 0..1 | Period | Validity Period URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod |
| Documentation for this format | ||||
This structure is derived from Composition
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 | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 | 0..1 | string | Plain text representation of the concept Fixed Value: Catalog | |
| category | 0..* | CodeableConcept | Kind of catalog Binding: CatalogType (example) | |
| subject | 0..0 | |||
| encounter | 0..0 | |||
| date | 1..1 | dateTime | Catalog content last editing time | |
| author | 1..* | Reference(Organization) | The organization authoring the catalog content | |
| title | ||||
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| translation | 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 | |
| relatesTo | ||||
| code | 1..1 | code | addendum | |
| event | 0..0 | |||
| section | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ValidityPeriod | SI | 0..1 | Period | Validity Period URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Version-independent identifier for the Composition |
| status | ?!ΣI | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | ΣI | 1..1 | CodeableConcept | Kind of composition: a catalog Binding: FHIRDocumentTypeCodes (preferred) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Catalog |
| category | ΣI | 0..* | CodeableConcept | Kind of catalog Binding: CatalogType (example) |
| date | ΣI | 1..1 | dateTime | Catalog content last editing time |
| author | ΣI | 1..* | Reference(Organization) | The organization authoring the catalog content |
| title | ΣI | 1..1 | string | Human Readable name/title |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| confidentiality | ΣI | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required) |
| attester | I | 0..1 | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | I | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | I | 1..1 | dateTime | When the composition was attested |
| party | I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition |
| custodian | ΣI | 1..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | I | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 1..1 | code | addendum Binding: DocumentRelationshipType (required) |
| target[x] | I | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Composition.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | CatalogType |
| Composition.confidentiality | required | v3.ConfidentialityClassification |
| Composition.attester.mode | required | CompositionAttestationMode |
| Composition.relatesTo.code | required | DocumentRelationshipType |
| Composition.event.code | example | v3.ActCode |
| Composition.section.code | example | DocumentSectionCodes |
| Composition.section.mode | required | ListMode |
| Composition.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Id | Path | Details | Requirements |
| dom-2 | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Composition.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.extension:ValidityPeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.extension:ValidityPeriod | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.title.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.title.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.title.extension:OtherTitle | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.title.extension:OtherTitle | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.confidentiality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.attester.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.attester.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.attester.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.attester.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester.time | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.attester.party | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.custodian | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.relatesTo.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.relatesTo.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.relatesTo.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.relatesTo.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo.target[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.event.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.event.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.event.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.event.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.event.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.event.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.event.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.section.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.section.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Composition.section.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.section.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.orderedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.emptyReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Composition.section.section | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Orders and Observations Work Group. Package hl7.fhir.uv.order-catalog#0.1.0 based on FHIR 4.0.1. Generated 2020-08-09
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change