Guide d'implémentation Fr Core
2.1.0 - trial-use
Guide d'implémentation Fr Core, published by Interop'Santé. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Interop-Sante/hl7.fhir.fr.core/ and changes regularly. See the Directory of published versions
Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-medication-administration-inhaled-oxygen | Version: 2.1.0 | |||
Active as of 2024-10-29 | Computable Name: FRCoreMedicationAdministrationInhaledOxygenProfile |
Profil se basant sur la ressource Medication Administration pour indiquer l’oxygène inhalé. Ce profil permet de compléter les informations de la ressource Observation saturation en oxygène avec les apports d’oxygène via une ventilation mécanique.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-medication-administration-inhaled-oxygen | |
medication[x] | 1..1 | CodeableConcept | What was administered | |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Product containing oxygen (medicinal product) | Administration d'oxygène Fixed Value: 767111007 | |
subject | 1..1 | Reference(FR Core Patient Profile) | Who received medication | |
performer | ||||
actor | 1..1 | Reference(RelatedPerson | Device | FR Core Practitioner Profile | PractitionerRole | FR Core Patient Profile) | Who performed the medication administration | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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. |
medication[x] | Σ | 1..1 | CodeableConcept | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
code | Σ | 1..1 | code | Product containing oxygen (medicinal product) | Administration d'oxygène Fixed Value: 767111007 |
subject | Σ | 1..1 | Reference(FR Core Patient Profile) | Who received medication |
effective[x] | Σ | 1..1 | Start and end time of administration | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | |
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | 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 | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
id | 0..1 | string | 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 | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-medication-administration-inhaled-oxygen | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (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: CommonLanguages (preferred): 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 | ||||
identifier | 0..* | Identifier | External identifier | |||||
instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | 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. | |||||
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 | CodeableConcept | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be 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 | Σ | 1..1 | 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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Product containing oxygen (medicinal product) | Administration d'oxygène Fixed Value: 767111007 | ||||
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 | ||||
subject | Σ | 1..1 | Reference(FR Core Patient Profile) | Who received medication | ||||
context | 0..1 | Reference(Encounter | EpisodeOfCare) | 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(RelatedPerson | Device | FR Core Practitioner Profile | PractitionerRole | FR Core Patient Profile) | 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(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
request | 0..1 | Reference(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. | |||||
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. | |||||
method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationAdministration.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes from the FHIR Standard | ||||
MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-category from the FHIR Standard | ||||
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | 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() | |
mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
This structure is derived from MedicationAdministration
Summary
Mandatory: 3 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-medication-administration-inhaled-oxygen | |
medication[x] | 1..1 | CodeableConcept | What was administered | |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Product containing oxygen (medicinal product) | Administration d'oxygène Fixed Value: 767111007 | |
subject | 1..1 | Reference(FR Core Patient Profile) | Who received medication | |
performer | ||||
actor | 1..1 | Reference(RelatedPerson | Device | FR Core Practitioner Profile | PractitionerRole | FR Core Patient Profile) | Who performed the medication administration | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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. |
medication[x] | Σ | 1..1 | CodeableConcept | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
code | Σ | 1..1 | code | Product containing oxygen (medicinal product) | Administration d'oxygène Fixed Value: 767111007 |
subject | Σ | 1..1 | Reference(FR Core Patient Profile) | Who received medication |
effective[x] | Σ | 1..1 | Start and end time of administration | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | |
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | 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 | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
id | 0..1 | string | 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 | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-medication-administration-inhaled-oxygen | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (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: CommonLanguages (preferred): 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 | ||||
identifier | 0..* | Identifier | External identifier | |||||
instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | 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. | |||||
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 | CodeableConcept | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be 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 | Σ | 1..1 | 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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Product containing oxygen (medicinal product) | Administration d'oxygène Fixed Value: 767111007 | ||||
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 | ||||
subject | Σ | 1..1 | Reference(FR Core Patient Profile) | Who received medication | ||||
context | 0..1 | Reference(Encounter | EpisodeOfCare) | 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(RelatedPerson | Device | FR Core Practitioner Profile | PractitionerRole | FR Core Patient Profile) | 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(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
request | 0..1 | Reference(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. | |||||
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. | |||||
method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationAdministration.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes from the FHIR Standard | ||||
MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-category from the FHIR Standard | ||||
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | 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() | |
mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
This structure is derived from MedicationAdministration
Summary
Mandatory: 3 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron