IHE Pharmacy Medication Record
0.1.0 - ci-build
IHE Pharmacy Medication Record
0.1.0 - ci-build
IHE Pharmacy Medication Record, published by Integrating the Healthcare Enterprise (IHE). This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/IHE/pharm-medo/ and changes regularly. See the Directory of published versions
| Official URL: http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/MedRecord-comp | Version: 0.1.0 | |||
| Active as of 2023-03-27 | Computable Name: MedRecordComposition | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
||||
The profile for how to organize the information in a medication Record
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | |
  meta | ||||
  profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
  Slices for section | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:type.coding.code | |
   section:MedRecordTreatment | S | 0..* | BackboneElement | Composition is broken into sections |
   entry | 0..* | Reference([Profile] - Treatment) | A reference to data that supports this section | |
| section:MedRecordTreatmentLine | S | 0..* | BackboneElement | Composition is broken into sections |
| entry | 0..* | Reference([Profile] - Treatment Line) | A reference to data that supports this section | |
| section:MedRecordMedicationSummaryView | S | 0..* | BackboneElement | Composition is broken into sections |
| entry | 0..* | Reference([Profile] - Summary View) | A reference to data that supports this section | |
 section:detailsRecord | S | 0..1 | BackboneElement | Composition is broken into sections |
| entry | 0..* | Reference([Profile] - Usage | [Profile] - Prescription | [Profile] - Dispense | [Profile] - Administration | [Profile] - Scheduled Administration) | A reference to data that supports this section | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
 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 | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:type.coding.code |
| section:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 entry | C | 0..* | Reference(Resource) | A reference to data that supports this section |
| section:MedRecordTreatment | SC | 0..* | BackboneElement | Composition is broken into sections |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Treatment) | A reference to data that supports this section |
| section:MedRecordTreatmentLine | SC | 0..* | BackboneElement | Composition is broken into sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Treatment Line) | A reference to data that supports this section |
| section:MedRecordMedicationSummaryView | SC | 0..* | BackboneElement | Composition is broken into sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Summary View) | A reference to data that supports this section |
| section:detailsRecord | SC | 0..1 | BackboneElement | Composition is broken into sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Usage | [Profile] - Prescription | [Profile] - Dispense | [Profile] - Administration | [Profile] - Scheduled Administration) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | 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, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | 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 |
|---|---|---|---|---|
| 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 |
| id | 0..1 | id | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| 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 | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| 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 (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. |
| subject | Σ | 0..* | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| 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. |
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:type.coding.code |
| section:All Slices | Content/Rules for all slices | |||
| 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 | |
| section:MedRecordTreatment | SC | 0..* | BackboneElement | Composition is broken into sections |
| 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([Profile] - Treatment) | 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 | |
| section:MedRecordTreatmentLine | SC | 0..* | BackboneElement | Composition is broken into sections |
| 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([Profile] - Treatment Line) | 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 | |
| section:MedRecordMedicationSummaryView | SC | 0..* | BackboneElement | Composition is broken into sections |
| 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([Profile] - Summary View) | 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 | |
| section:detailsRecord | SC | 0..1 | BackboneElement | Composition is broken into sections |
| 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([Profile] - Usage | [Profile] - Prescription | [Profile] - Dispense | [Profile] - Administration | [Profile] - Scheduled Administration) | 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 |
| Composition.meta.security | extensible | AllSecurityLabels |
| Composition.meta.tag | example | CommonTags |
| Composition.language | required | AllLanguages |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | ReferencedItemCategoryValueSet |
| Composition.attester.mode | preferred | CompositionAttestationMode |
| Composition.event.detail | example | ActCode |
| Composition.section.code | example | DocumentSectionCodes |
| Composition.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Composition.section:MedRecordTreatment.code | example | DocumentSectionCodes |
| Composition.section:MedRecordTreatment.orderedBy | preferred | ListOrderCodes |
| Composition.section:MedRecordTreatment.emptyReason | preferred | ListEmptyReasons |
| Composition.section:MedRecordTreatmentLine.code | example | DocumentSectionCodes |
| Composition.section:MedRecordTreatmentLine.orderedBy | preferred | ListOrderCodes |
| Composition.section:MedRecordTreatmentLine.emptyReason | preferred | ListEmptyReasons |
| Composition.section:MedRecordMedicationSummaryView.code | example | DocumentSectionCodes |
| Composition.section:MedRecordMedicationSummaryView.orderedBy | preferred | ListOrderCodes |
| Composition.section:MedRecordMedicationSummaryView.emptyReason | preferred | ListEmptyReasons |
| Composition.section:detailsRecord.code | example | DocumentSectionCodes |
| Composition.section:detailsRecord.orderedBy | preferred | ListOrderCodes |
| Composition.section:detailsRecord.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | 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, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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: 0 element (1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
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 | |
| meta | ||||
| profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| Slices for section | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:type.coding.code | |
| section:MedRecordTreatment | S | 0..* | BackboneElement | Composition is broken into sections |
| entry | 0..* | Reference([Profile] - Treatment) | A reference to data that supports this section | |
| section:MedRecordTreatmentLine | S | 0..* | BackboneElement | Composition is broken into sections |
| entry | 0..* | Reference([Profile] - Treatment Line) | A reference to data that supports this section | |
| section:MedRecordMedicationSummaryView | S | 0..* | BackboneElement | Composition is broken into sections |
| entry | 0..* | Reference([Profile] - Summary View) | A reference to data that supports this section | |
| section:detailsRecord | S | 0..1 | BackboneElement | Composition is broken into sections |
| entry | 0..* | Reference([Profile] - Usage | [Profile] - Prescription | [Profile] - Dispense | [Profile] - Administration | [Profile] - Scheduled Administration) | A reference to data that supports this section | |
| Documentation for this format | ||||
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 | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| 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 | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:type.coding.code |
| section:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference(Resource) | A reference to data that supports this section |
| section:MedRecordTreatment | SC | 0..* | BackboneElement | Composition is broken into sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Treatment) | A reference to data that supports this section |
| section:MedRecordTreatmentLine | SC | 0..* | BackboneElement | Composition is broken into sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Treatment Line) | A reference to data that supports this section |
| section:MedRecordMedicationSummaryView | SC | 0..* | BackboneElement | Composition is broken into sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Summary View) | A reference to data that supports this section |
| section:detailsRecord | SC | 0..1 | BackboneElement | Composition is broken into sections |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entry | C | 0..* | Reference([Profile] - Usage | [Profile] - Prescription | [Profile] - Dispense | [Profile] - Administration | [Profile] - Scheduled Administration) | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | 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, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | 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 |
|---|---|---|---|---|
| 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 |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| 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 | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| 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 (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. |
| subject | Σ | 0..* | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| 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. |
| Slices for section | C | 0..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:type.coding.code |
| section:All Slices | Content/Rules for all slices | |||
| 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 | |
| section:MedRecordTreatment | SC | 0..* | BackboneElement | Composition is broken into sections |
| 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([Profile] - Treatment) | 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 | |
| section:MedRecordTreatmentLine | SC | 0..* | BackboneElement | Composition is broken into sections |
| 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([Profile] - Treatment Line) | 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 | |
| section:MedRecordMedicationSummaryView | SC | 0..* | BackboneElement | Composition is broken into sections |
| 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([Profile] - Summary View) | 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 | |
| section:detailsRecord | SC | 0..1 | BackboneElement | Composition is broken into sections |
| 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([Profile] - Usage | [Profile] - Prescription | [Profile] - Dispense | [Profile] - Administration | [Profile] - Scheduled Administration) | 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 |
| Composition.meta.security | extensible | AllSecurityLabels |
| Composition.meta.tag | example | CommonTags |
| Composition.language | required | AllLanguages |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | ReferencedItemCategoryValueSet |
| Composition.attester.mode | preferred | CompositionAttestationMode |
| Composition.event.detail | example | ActCode |
| Composition.section.code | example | DocumentSectionCodes |
| Composition.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Composition.section:MedRecordTreatment.code | example | DocumentSectionCodes |
| Composition.section:MedRecordTreatment.orderedBy | preferred | ListOrderCodes |
| Composition.section:MedRecordTreatment.emptyReason | preferred | ListEmptyReasons |
| Composition.section:MedRecordTreatmentLine.code | example | DocumentSectionCodes |
| Composition.section:MedRecordTreatmentLine.orderedBy | preferred | ListOrderCodes |
| Composition.section:MedRecordTreatmentLine.emptyReason | preferred | ListEmptyReasons |
| Composition.section:MedRecordMedicationSummaryView.code | example | DocumentSectionCodes |
| Composition.section:MedRecordMedicationSummaryView.orderedBy | preferred | ListOrderCodes |
| Composition.section:MedRecordMedicationSummaryView.emptyReason | preferred | ListEmptyReasons |
| Composition.section:detailsRecord.code | example | DocumentSectionCodes |
| Composition.section:detailsRecord.orderedBy | preferred | ListOrderCodes |
| Composition.section:detailsRecord.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | 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, Composition.section:MedRecordTreatment, Composition.section:MedRecordTreatmentLine, Composition.section:MedRecordMedicationSummaryView, Composition.section:detailsRecord | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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: 0 element (1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ Integrating the Healthcare Enterprise (IHE). Package ihe-fhir-pharm-medicationrecord#0.1.0 based on FHIR 5.0.0. Generated 2023-03-27
Links: Table of Contents |
QA Report
Version History |
|
Propose a change