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-MedicationDispense-1

Indicates that a medication product is to be or has been dispensed for a named person/patient.

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*MedicationDispenseDispensing a medication to a named 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 Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..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)
... partOf 0..*Reference(CareConnect-Procedure-1)Event that dispense is part of
... status ?!Σ0..1codepreparation | in-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... category 0..1CodeableConceptType of medication dispense
Binding: MedicationDispenseCategory (preferred)
... medication[x] Σ1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ1..1Reference(CareConnect-Medication-1)What medication was supplied
... subject Σ0..1Reference(Group | CareConnect-Patient-1)Who the dispense is for
... context 0..1Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... performer I0..*BackboneElementWho performed event
.... 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-RelatedPerson-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)Individual who was performing
.... onBehalfOf 0..1Reference(CareConnect-Organization-1)Organization organization was acting for
... authorizingPrescription 0..*Reference(CareConnect-MedicationRequest-1)Medication order that authorizes the dispense
... type 0..1CodeableConceptTo identify the type of medication supply.
Binding: Care Connect Medication Supply Type (preferred)
... quantity 0..1SimpleQuantityAmount dispensed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Extension-CareConnect-MedicationQuantityText-1 0..1stringQuantity representation
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationQuantityText-1
.... value Σ0..1decimalNumerical value (with implicit precision)
.... unit Σ0..1stringUnit representation
.... system ΣI0..1uriSystem that defines coded unit form
.... code Σ0..1codeCoded form of the unit
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(CareConnect-Location-1)Where the medication was sent
... receiver 0..*Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1)Who collected the medication
... note 0..*AnnotationInformation about the dispense
.... 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
..... authorReferenceReference(CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution I0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example)
.... responsibleParty 0..*Reference(CareConnect-Practitioner-1)Who is responsible for the substitution
... detectedIssue 0..*Reference(DetectedIssue)Clinical issue with action
... notDone 0..1booleanWhether the dispense was or was not performed
... notDoneReason[x] 0..1Why a dispense was not performed
.... notDoneReasonCodeableConceptCodeableConcept
.... notDoneReasonReferenceReference(DetectedIssue)
... eventHistory 0..*Reference(Provenance)A list of releveant lifecycle events

doco Documentation for this format

Differential View

This structure is derived from MedicationDispense

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*MedicationDispenseDispensing a medication to a named 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 Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..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)
... partOf 0..*Reference(CareConnect-Procedure-1)Event that dispense is part of
... status ?!Σ0..1codepreparation | in-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... category 0..1CodeableConceptType of medication dispense
Binding: MedicationDispenseCategory (preferred)
... medication[x] Σ1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ1..1Reference(CareConnect-Medication-1)What medication was supplied
... subject Σ0..1Reference(Group | CareConnect-Patient-1)Who the dispense is for
... context 0..1Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... performer I0..*BackboneElementWho performed event
.... 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-RelatedPerson-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)Individual who was performing
.... onBehalfOf 0..1Reference(CareConnect-Organization-1)Organization organization was acting for
... authorizingPrescription 0..*Reference(CareConnect-MedicationRequest-1)Medication order that authorizes the dispense
... type 0..1CodeableConceptTo identify the type of medication supply.
Binding: Care Connect Medication Supply Type (preferred)
... quantity 0..1SimpleQuantityAmount dispensed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Extension-CareConnect-MedicationQuantityText-1 0..1stringQuantity representation
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationQuantityText-1
.... value Σ0..1decimalNumerical value (with implicit precision)
.... unit Σ0..1stringUnit representation
.... system ΣI0..1uriSystem that defines coded unit form
.... code Σ0..1codeCoded form of the unit
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(CareConnect-Location-1)Where the medication was sent
... receiver 0..*Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1)Who collected the medication
... note 0..*AnnotationInformation about the dispense
.... 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
..... authorReferenceReference(CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution I0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example)
.... responsibleParty 0..*Reference(CareConnect-Practitioner-1)Who is responsible for the substitution
... detectedIssue 0..*Reference(DetectedIssue)Clinical issue with action
... notDone 0..1booleanWhether the dispense was or was not performed
... notDoneReason[x] 0..1Why a dispense was not performed
.... notDoneReasonCodeableConceptCodeableConcept
.... notDoneReasonReferenceReference(DetectedIssue)
... eventHistory 0..*Reference(Provenance)A list of releveant lifecycle events

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
MedicationDispense.languageextensibleCommon Languages
Max Binding: All Languages
MedicationDispense.identifier.userequiredIdentifierUse
MedicationDispense.identifier.typeextensibleIdentifier Type Codes
MedicationDispense.statusrequiredMedicationDispenseStatus
MedicationDispense.categorypreferredMedicationDispenseCategory
MedicationDispense.typepreferredCare Connect Medication Supply Type
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason

Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MedicationDispenseIf 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-3MedicationDispenseIf 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()
mdd-1MedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
ele-1MedicationDispense.performerAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1MedicationDispense.substitutionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())