HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - STU1 International flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

Resource Profile: PT_MedicationAdministration

Official URL: http://hl7.pt/fhir/core/StructureDefinition/PTMedicationAdministration Version: 0.0.1
Active as of 2024-09-23 Computable Name: PT_MedicationAdministration

A generic MedicationAdministration resource for Portugal

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Location 0..1 Reference(PT_Location) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/LocationAct
.... statusReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/StatusReason
.... recorded 0..* dateTime Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/Recorded
.... isSubPotent 0..* boolean Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/IsSubPotent
.... subPotentReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/SubPotentReason
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(PT_MedicationAdministration | PT_Procedure) Part of referenced event
... statusReason 0..* CodeableConcept Reason administration not performed
.... coding
..... system 0..1 uri Identity of the terminology system
..... code 0..1 code Symbol in syntax defined by the system
..... display 0..1 string Representation defined by the system
... medication[x] 1..1 What was administered
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(PT_Medication)
... subject 1..1 Reference(PT_Patient) Who received medication
... context 0..1 Reference(PT_Encounter) Encounter or Episode of Care administered as part of
... effective[x] 1..1 dateTime, Period Start and end time of administration
... performer
.... actor 1..1 Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | Device) Who performed the medication administration
... reasonReference 0..* Reference(PT_Condition) Condition or observation that supports why the medication was administered
... request 0..1 Reference(PT_MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage
.... site 0..1 CodeableConcept Body site administered to
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: http:snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
.... route 0..1 CodeableConcept Path of substance into body
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: https:www.edqm.eu/
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
.... method 0..1 CodeableConcept How drug was administered
..... coding
...... system 0..1 uri Identity of the terminology system
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
.... dose 0..1 SimpleQuantity Amount of medication per dose
..... value 0..1 decimal Numerical value (with implicit precision)
..... unit 0..1 string Unit representation
..... system 0..1 uri System that defines coded unit form
Fixed Value: https:ucum.org/
..... code 0..1 code Coded form of the unit
.... rate[x] 0..1 Ratio, SimpleQuantity Dose quantity per unit of time

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Location 0..1 Reference(PT_Location) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/LocationAct
.... statusReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/StatusReason
.... recorded 0..* dateTime Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/Recorded
.... isSubPotent 0..* boolean Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/IsSubPotent
.... subPotentReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/SubPotentReason
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(PT_MedicationAdministration | PT_Procedure) Part of referenced event
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... medication[x] Σ 1..1 What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(PT_Medication)
... subject Σ 1..1 Reference(PT_Patient) Who received medication
... context 0..1 Reference(PT_Encounter) Encounter or Episode of Care administered as part of
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... reasonReference 0..* Reference(PT_Condition) Condition or observation that supports why the medication was administered
... request 0..1 Reference(PT_MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Location 0..1 Reference(PT_Location) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/LocationAct
.... statusReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/StatusReason
.... recorded 0..* dateTime Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/Recorded
.... isSubPotent 0..* boolean Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/IsSubPotent
.... subPotentReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/SubPotentReason
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(PT_MedicationAdministration | PT_Procedure) Part of referenced event
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... medication[x] Σ 1..1 What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(PT_Medication)
... subject Σ 1..1 Reference(PT_Patient) Who received medication
... context 0..1 Reference(PT_Encounter) Encounter or Episode of Care administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 0..* BackboneElement Who performed the medication administration and what they did
.... 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
.... function 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ 1..1 Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | Device) Who performed the medication administration
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..* Reference(PT_Condition) Condition or observation that supports why the medication was administered
... request 0..1 Reference(PT_MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage C 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... 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
.... text 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http:snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... route 0..1 CodeableConcept Path of substance into body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: https:www.edqm.eu/
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... dose 0..1 SimpleQuantity Amount of medication per dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ 0..1 decimal Numerical value (with implicit precision)
..... unit Σ 0..1 string Unit representation
..... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: https:ucum.org/
..... code Σ 0..1 code Coded form of the unit
.... rate[x] 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Location 0..1 Reference(PT_Location) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/LocationAct
.... statusReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/StatusReason
.... recorded 0..* dateTime Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/Recorded
.... isSubPotent 0..* boolean Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/IsSubPotent
.... subPotentReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/SubPotentReason
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(PT_MedicationAdministration | PT_Procedure) Part of referenced event
... statusReason 0..* CodeableConcept Reason administration not performed
.... coding
..... system 0..1 uri Identity of the terminology system
..... code 0..1 code Symbol in syntax defined by the system
..... display 0..1 string Representation defined by the system
... medication[x] 1..1 What was administered
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(PT_Medication)
... subject 1..1 Reference(PT_Patient) Who received medication
... context 0..1 Reference(PT_Encounter) Encounter or Episode of Care administered as part of
... effective[x] 1..1 dateTime, Period Start and end time of administration
... performer
.... actor 1..1 Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | Device) Who performed the medication administration
... reasonReference 0..* Reference(PT_Condition) Condition or observation that supports why the medication was administered
... request 0..1 Reference(PT_MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage
.... site 0..1 CodeableConcept Body site administered to
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: http:snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
.... route 0..1 CodeableConcept Path of substance into body
..... coding
...... system 0..1 uri Identity of the terminology system
Fixed Value: https:www.edqm.eu/
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
.... method 0..1 CodeableConcept How drug was administered
..... coding
...... system 0..1 uri Identity of the terminology system
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
.... dose 0..1 SimpleQuantity Amount of medication per dose
..... value 0..1 decimal Numerical value (with implicit precision)
..... unit 0..1 string Unit representation
..... system 0..1 uri System that defines coded unit form
Fixed Value: https:ucum.org/
..... code 0..1 code Coded form of the unit
.... rate[x] 0..1 Ratio, SimpleQuantity Dose quantity per unit of time

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Location 0..1 Reference(PT_Location) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/LocationAct
.... statusReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/StatusReason
.... recorded 0..* dateTime Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/Recorded
.... isSubPotent 0..* boolean Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/IsSubPotent
.... subPotentReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/SubPotentReason
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(PT_MedicationAdministration | PT_Procedure) Part of referenced event
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... medication[x] Σ 1..1 What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(PT_Medication)
... subject Σ 1..1 Reference(PT_Patient) Who received medication
... context 0..1 Reference(PT_Encounter) Encounter or Episode of Care administered as part of
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... reasonReference 0..* Reference(PT_Condition) Condition or observation that supports why the medication was administered
... request 0..1 Reference(PT_MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Location 0..1 Reference(PT_Location) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/LocationAct
.... statusReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/StatusReason
.... recorded 0..* dateTime Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/Recorded
.... isSubPotent 0..* boolean Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/IsSubPotent
.... subPotentReason 0..* CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/SubPotentReason
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(PT_MedicationAdministration | PT_Procedure) Part of referenced event
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.

... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... medication[x] Σ 1..1 What was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(PT_Medication)
... subject Σ 1..1 Reference(PT_Patient) Who received medication
... context 0..1 Reference(PT_Encounter) Encounter or Episode of Care administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 0..* BackboneElement Who performed the medication administration and what they did
.... 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
.... function 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ 1..1 Reference(PT_Practitioner | PT_Patient | PT_RelatedPerson | Device) Who performed the medication administration
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..* Reference(PT_Condition) Condition or observation that supports why the medication was administered
... request 0..1 Reference(PT_MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage C 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... 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
.... text 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http:snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... route 0..1 CodeableConcept Path of substance into body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: https:www.edqm.eu/
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... dose 0..1 SimpleQuantity Amount of medication per dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ 0..1 decimal Numerical value (with implicit precision)
..... unit Σ 0..1 string Unit representation
..... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: https:ucum.org/
..... code Σ 0..1 code Coded form of the unit
.... rate[x] 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()

 

Other representations of profile: CSV, Excel, Schematron