Vulcan ePI FHIR Implementation Guide
0.1.0 - CI Build
Vulcan ePI FHIR Implementation Guide
0.1.0 - CI Build
Vulcan ePI FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/vulcan-epi/StructureDefinition/Composition-uv-epi | Version: 0.1.0 | |||
| Active as of 2022-09-02 | Computable Name: CompositionUvEpi | |||
The Composition captures the section headings, sub-section headings, and narrative text (For example, paragraphs, bulleted lists, tables) in an ePI.
This profile represents the constraints applied to the Composition resource used in an Electronic Product Information (ePI) document.
Usage:
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 | Electronic Product Information composition | |
  identifier | 0..1 | Identifier | Unique identifier only for this version of the Composition | |
| status | 1..1 | code | preliminary|final|amended|entered-in-error|deprecated | |
| type | 1..1 | CodeableConcept | Type of ePI document template Binding: ePI document types (extensible) | |
 category | 0..* | CodeableConcept | High-level type of document Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: X-EPI | |
 display | 1..1 | string | Representation defined by the system Fixed Value: electronic Product Information | |
| subject | 0..1 | Reference(Resource) | The authorized medicinal product(s) that this ePI's composition is about | |
| date | 1..1 | dateTime | Date of last revision for this version of the authorized ePI. | |
| author | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The Organization responsible for the ePI | |
| title | 1..1 | string | Title of the ePI Document | |
| attester | 0..0 | |||
| custodian | 0..0 | |||
| relatesTo | 0..* | RelatedArtifact | Cross-reference to anotherother ePI compositions or ePI document()s) | |
| section | 1..* | BackboneElement | Level 1 section heading for the whole ePI | |
| code | 1..1 | CodeableConcept | unique identifier for this section. | |
| text | 0..1 | Narrative | Narrative text for this section. | |
| orderedBy | 0..1 | CodeableConcept | Order of section entries. | |
| emptyReason | 0..1 | CodeableConcept | Reason the section is empty. | |
| section | 0..* | Nested Sections (sub-section headings for level 2, 3, 4 or 5). | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | Composition | Electronic Product Information composition | |||||
 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: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | ||||
| identifier | Σ | 0..1 | Identifier | Unique identifier only for this version of the Composition | ||||
| status | ?!Σ | 1..1 | code | preliminary|final|amended|entered-in-error|deprecated Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Type of ePI document template Binding: ePI document types (extensible) | ||||
| category | Σ | 0..* | CodeableConcept | High-level type of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: X-EPI | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: electronic Product Information | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
 subject | Σ | 0..1 | Reference(Resource) | The authorized medicinal product(s) that this ePI's composition is about | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Date of last revision for this version of the authorized ePI. | ||||
| author | Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The Organization responsible for the ePI | ||||
| title | Σ | 1..1 | string | Title of the ePI Document | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: Confidentiality (2.0.0) (required): Codes specifying the level of confidentiality of the composition. | ||||
| relatesTo | 0..* | RelatedArtifact | Cross-reference to anotherother ePI compositions or ePI document()s) | |||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id | 0..1 | id | 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 | ||||
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| section | I | 1..* | BackboneElement | Level 1 section heading for the whole ePI | ||||
| id | 0..1 | id | 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 | 1..1 | CodeableConcept | unique identifier for this section. 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 | I | 0..1 | Narrative | Narrative text for this section. | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries. Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | I | 0..1 | CodeableConcept | Reason the section is empty. Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | I | 0..* | See section (Composition) | Nested Sections (sub-section headings for level 2, 3, 4 or 5). | ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | Composition | Electronic Product Information composition | |
| 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 | Electronic Product Information composition | |
| identifier | 0..1 | Identifier | Unique identifier only for this version of the Composition | |
| status | 1..1 | code | preliminary|final|amended|entered-in-error|deprecated | |
| type | 1..1 | CodeableConcept | Type of ePI document template Binding: ePI document types (extensible) | |
| category | 0..* | CodeableConcept | High-level type of document Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: X-EPI | |
| display | 1..1 | string | Representation defined by the system Fixed Value: electronic Product Information | |
| subject | 0..1 | Reference(Resource) | The authorized medicinal product(s) that this ePI's composition is about | |
| date | 1..1 | dateTime | Date of last revision for this version of the authorized ePI. | |
| author | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The Organization responsible for the ePI | |
| title | 1..1 | string | Title of the ePI Document | |
| attester | 0..0 | |||
| custodian | 0..0 | |||
| relatesTo | 0..* | RelatedArtifact | Cross-reference to anotherother ePI compositions or ePI document()s) | |
| section | 1..* | BackboneElement | Level 1 section heading for the whole ePI | |
| code | 1..1 | CodeableConcept | unique identifier for this section. | |
| text | 0..1 | Narrative | Narrative text for this section. | |
| orderedBy | 0..1 | CodeableConcept | Order of section entries. | |
| emptyReason | 0..1 | CodeableConcept | Reason the section is empty. | |
| section | 0..* | Nested Sections (sub-section headings for level 2, 3, 4 or 5). | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | Composition | Electronic Product Information composition | |||||
| 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: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | ||||
| identifier | Σ | 0..1 | Identifier | Unique identifier only for this version of the Composition | ||||
| status | ?!Σ | 1..1 | code | preliminary|final|amended|entered-in-error|deprecated Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Type of ePI document template Binding: ePI document types (extensible) | ||||
| category | Σ | 0..* | CodeableConcept | High-level type of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: X-EPI | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: electronic Product Information | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| subject | Σ | 0..1 | Reference(Resource) | The authorized medicinal product(s) that this ePI's composition is about | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Date of last revision for this version of the authorized ePI. | ||||
| author | Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The Organization responsible for the ePI | ||||
| title | Σ | 1..1 | string | Title of the ePI Document | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: Confidentiality (2.0.0) (required): Codes specifying the level of confidentiality of the composition. | ||||
| relatesTo | 0..* | RelatedArtifact | Cross-reference to anotherother ePI compositions or ePI document()s) | |||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id | 0..1 | id | 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 | ||||
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| section | I | 1..* | BackboneElement | Level 1 section heading for the whole ePI | ||||
| id | 0..1 | id | 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 | 1..1 | CodeableConcept | unique identifier for this section. 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 | I | 0..1 | Narrative | Narrative text for this section. | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries. Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | I | 0..1 | CodeableConcept | Reason the section is empty. Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | I | 0..* | See section (Composition) | Nested Sections (sub-section headings for level 2, 3, 4 or 5). | ||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Composition.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Composition.status | required | CompositionStatus |
| Composition.type | extensible | VsEpiType |
| Composition.category | example | Pattern: LOINC code X-EPI("electronic Product Information") |
| Composition.confidentiality | required | Confidentiality |
| Composition.attester.mode | preferred | CompositionAttestationMode |
| Composition.event.code | example | ActCode |
| Composition.section.code | example | DocumentSectionCodes |
| Composition.section.mode | required | ListMode |
| Composition.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
IG © 2021+ . Package hl7.fhir.uv.vulcan-epi#0.1.0 based on FHIR 5.0.0-snapshot1. Generated 2022-09-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change