This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v0.9.1: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/mcode/StructureDefinition/obf-MedicationAction
Abstract class representing medication exposure, independent of whether reported in a medication statement or medication administration. Does not include medication requests (prescriptions).
This profile builds on DomainResource.
This profile was published on Thu Aug 01 00:00:00 EDT 2019 as a active by HL7 International Clinical Interoperability Council.
Summary
Mandatory: 0 element (4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
obf.MedicationAction maps to DomainResource: Language maps to language ImplicitRules maps to implicitRules Metadata.VersionId maps to meta.versionId Metadata.SourceSystem maps to meta.source Metadata.Profile maps to meta.profile Metadata.LastUpdated maps to meta.lastUpdated Metadata.SecurityLabel maps to meta.security Metadata.Tag maps to meta.tag Narrative maps to text
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DomainResource | I | 0..* | obf-MedicationAction dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
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) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 4..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
obf-Status-extension | 1..1 | CodeableConcept | Status URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension | |
obf-datatype-Identifier-extension | 0..* | Identifier | Identifier URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension | |
obf-SubjectOfRecord-extension | 1..1 | Reference(obf-Patient | US Core Practitioner Profile | Group | US Core Device Profile | Specimen | US Core Location Profile | US Core Medication Profile | ResearchSubject) | SubjectOfRecord URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-SubjectOfRecord-extension | |
obf-CareContext-extension | 0..1 | Reference(US Core Encounter Profile | EpisodeOfCare) | CareContext URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-CareContext-extension | |
obf-StatementDateTime-extension | 0..1 | dateTime | StatementDateTime URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-StatementDateTime-extension | |
obf-ReasonCode-extension | 0..* | CodeableConcept | ReasonCode URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-ReasonCode-extension | |
obf-ReasonReference-extension | 0..* | Reference(obf-Condition | obf-Observation | obf-DiagnosticReport | US Core DocumentReference Profile | obf-Procedure) | ReasonReference URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-ReasonReference-extension | |
obf-BasedOn-extension | 0..* | Reference(ServiceRequest | US Core MedicationRequest Profile) | BasedOn URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-BasedOn-extension | |
obf-datatype-OccurrenceTimeOrPeriod-extension | 1..1 | date, dateTime, Period | OccurrenceTimeOrPeriod URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-OccurrenceTimeOrPeriod-extension | |
obf-Participation-extension | 0..* | (Complex) | Participation URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Participation-extension | |
obf-MedicationCodeOrReference-extension | 1..1 | CodeableConcept | MedicationCodeOrReference URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-MedicationCodeOrReference-extension | |
obf-Dosage-extension | 0..1 | Dosage | Dosage URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Dosage-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
Documentation for this format |
Summary
Mandatory: 0 element (4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
obf.MedicationAction maps to DomainResource: Language maps to language ImplicitRules maps to implicitRules Metadata.VersionId maps to meta.versionId Metadata.SourceSystem maps to meta.source Metadata.Profile maps to meta.profile Metadata.LastUpdated maps to meta.lastUpdated Metadata.SecurityLabel maps to meta.security Metadata.Tag maps to meta.tag Narrative maps to text
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DomainResource | I | 0..* | obf-MedicationAction dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
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) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 4..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
obf-Status-extension | 1..1 | CodeableConcept | Status URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Status-extension | |
obf-datatype-Identifier-extension | 0..* | Identifier | Identifier URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-Identifier-extension | |
obf-SubjectOfRecord-extension | 1..1 | Reference(obf-Patient | US Core Practitioner Profile | Group | US Core Device Profile | Specimen | US Core Location Profile | US Core Medication Profile | ResearchSubject) | SubjectOfRecord URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-SubjectOfRecord-extension | |
obf-CareContext-extension | 0..1 | Reference(US Core Encounter Profile | EpisodeOfCare) | CareContext URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-CareContext-extension | |
obf-StatementDateTime-extension | 0..1 | dateTime | StatementDateTime URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-StatementDateTime-extension | |
obf-ReasonCode-extension | 0..* | CodeableConcept | ReasonCode URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-ReasonCode-extension | |
obf-ReasonReference-extension | 0..* | Reference(obf-Condition | obf-Observation | obf-DiagnosticReport | US Core DocumentReference Profile | obf-Procedure) | ReasonReference URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-ReasonReference-extension | |
obf-BasedOn-extension | 0..* | Reference(ServiceRequest | US Core MedicationRequest Profile) | BasedOn URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-BasedOn-extension | |
obf-datatype-OccurrenceTimeOrPeriod-extension | 1..1 | date, dateTime, Period | OccurrenceTimeOrPeriod URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-datatype-OccurrenceTimeOrPeriod-extension | |
obf-Participation-extension | 0..* | (Complex) | Participation URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Participation-extension | |
obf-MedicationCodeOrReference-extension | 1..1 | CodeableConcept | MedicationCodeOrReference URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-MedicationCodeOrReference-extension | |
obf-Dosage-extension | 0..1 | Dosage | Dosage URL: http://hl7.org/fhir/us/mcode/StructureDefinition/obf-Dosage-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Conformance | ValueSet |
DomainResource.language | preferred | CommonLanguages Max Binding: AllLanguages |
Id | Path | Details | Requirements |
dom-2 | DomainResource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | DomainResource | 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-3 | DomainResource | 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-6 | DomainResource | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | DomainResource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |