INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

StructureDefinition: CareConnect-MedicationAdministration-1

Describes the event of a patient consuming or otherwise being administered a medication.

The official URL for this profile is: 

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-MedicationAdministration-1

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 I0..*MedicationAdministrationAdministration of medication to a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... definition Σ0..*Reference(PlanDefinition | ActivityDefinition)Instantiates protocol or definition
... partOf Σ0..*Reference(CareConnect-Procedure-1 | CareConnect-MedicationAdministration-1)Part of referenced event
... status ?!Σ1..1codein-progress | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatus (required)
... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministrationCategory (preferred)
... medication[x] Σ1..1(Slice Definition)What was administered
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ1..1Reference(Medication | CareConnect-Medication-1)What was administered
... subject Σ1..1Reference(Group | CareConnect-Patient-1)Who received medication
... context 0..1Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer ΣI0..*BackboneElementWho administered substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... actor Σ1..1Reference(Device | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)Individual who was performing
.... onBehalfOf 0..1Reference(CareConnect-Organization-1)Organization organization was acting for
... notGiven ?!Σ0..1booleanTrue if medication not administered
... reasonNotGiven I0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonCode I0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... reasonReference 0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)Condition or Observation that supports why the medication was administered
... prescription 0..1Reference(CareConnect-MedicationRequest-1)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorStringstring
..... authorReferenceReference(CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... dosage I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route 0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Medication Dosage Route (example)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..1(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMED CT Administration Method Codes (example)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

This structure is derived from MedicationAdministration

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.dosage.route.coding is sliced based on the value of value:system

Differential View

This structure is derived from MedicationAdministration

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*MedicationAdministrationAdministration of medication to a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... definition Σ0..*Reference(PlanDefinition | ActivityDefinition)Instantiates protocol or definition
... partOf Σ0..*Reference(CareConnect-Procedure-1 | CareConnect-MedicationAdministration-1)Part of referenced event
... status ?!Σ1..1codein-progress | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatus (required)
... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministrationCategory (preferred)
... medication[x] Σ1..1(Slice Definition)What was administered
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ1..1Reference(Medication | CareConnect-Medication-1)What was administered
... subject Σ1..1Reference(Group | CareConnect-Patient-1)Who received medication
... context 0..1Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer ΣI0..*BackboneElementWho administered substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... actor Σ1..1Reference(Device | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)Individual who was performing
.... onBehalfOf 0..1Reference(CareConnect-Organization-1)Organization organization was acting for
... notGiven ?!Σ0..1booleanTrue if medication not administered
... reasonNotGiven I0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonCode I0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... reasonReference 0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)Condition or Observation that supports why the medication was administered
... prescription 0..1Reference(CareConnect-MedicationRequest-1)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorStringstring
..... authorReferenceReference(CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... dosage I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route 0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Medication Dosage Route (example)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..1(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMED CT Administration Method Codes (example)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.languageextensibleCommon Languages
Max Binding: All Languages
MedicationAdministration.identifier.userequiredIdentifierUse
MedicationAdministration.identifier.typeextensibleIdentifier Type Codes
MedicationAdministration.statusrequiredMedicationAdministrationStatus
MedicationAdministration.categorypreferredMedicationAdministrationCategory
MedicationAdministration.reasonNotGivenexampleSNOMED CT Reason Medication Not Given Codes
MedicationAdministration.reasonCodeexampleReason Medication Given Codes
MedicationAdministration.dosage.siteexampleSNOMED CT Anatomical Structure for Administration Site Codes
MedicationAdministration.dosage.routeexampleSNOMED CT Route Codes
MedicationAdministration.dosage.route.coding:snomedCTexampleCare Connect Medication Dosage Route
MedicationAdministration.dosage.methodexampleSNOMED CT Administration Method Codes

Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MedicationAdministrationIf 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-3MedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
mad-2MedicationAdministrationReason not given is only permitted if NotGiven is true
: reasonNotGiven.empty() or notGiven = true
mad-3MedicationAdministrationReason given is only permitted if NotGiven is false
: reasonCode.empty() or notGiven.empty() or notGiven = 'false'
ele-1MedicationAdministration.performerAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1MedicationAdministration.dosageAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
mad-1MedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()