Da Vinci Payer Data Exchange
1.0.0 - STU1

This page is part of the Da Vinci Payer Data Exchange (v1.0.0: STU1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: PDex MedicationDispense

Defining URL:http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense
Version:1.0.0
Name:PdexMedicationDispense
Title:PDex MedicationDispense
Status:Draft as of 2020-12-22T14:17:18+00:00
Definition:

Prescription Medications dispensed by a pharmacy to a health plan member and paid for in full, or in part, by the health plan

Publisher:HL7 International
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense

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 0..*MedicationDispenseDispensing a medication to a named patient
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... DispenseRefill 0..1QuantityRefill number of this prescription
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill
.... valueQuantity 0..1QuantityRefill number of this prescription
... status S1..1codecompleted
Binding: MedicationDispense Status Codes (required)
... medicationCodeableConcept 1..1CodeableConceptBilling, service, product, or drug code
Binding: FDA National Drug Code (NDC) (required)
... subject S1..1Reference(US Core Patient Profile)The patient who is prescribed the medication
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile.
... performer 0..*BackboneElementWho performed the dispense event
.... function 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: MedicationDispense Performer Function Codes (example)
.... actor 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Individual or device performing the dispense
... location 0..1Reference(US Core Location Profile)Where the dispense occurred
... authorizingPrescription 0..*Reference(US Core MedicationRequest Profile)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityBilling, service, product, or drug code
... daysSupply 0..1SimpleQuantityMedication expressed as a timing amount.
... substitution S0..1BackboneElementWhether a substitution was performed on the dispense
.... wasSubstituted S1..1booleanWhether a substitution was or was not performed on the dispense

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*MedicationDispenseDispensing a medication to a named patient
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... DispenseRefill 0..1QuantityRefill number of this prescription
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill"
.... value[x] 0..1(Slice Definition)Refill number of this prescription
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 0..1QuantityRefill number of this prescription
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... partOf 0..*Reference(Procedure)Event that dispense is part of
... status ?!SΣ1..1codecompleted
Binding: MedicationDispense Status Codes (required)
... statusReason[x] 0..1Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConceptType of dispense action
Binding: MedicationDispense Category Codes (required)
... medication[x] Σ1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medication[x]:medicationCodeableConcept Σ1..1CodeableConceptBilling, service, product, or drug code
Binding: FDA National Drug Code (NDC) (required)
... subject SΣ1..1Reference(US Core Patient Profile)The patient who is prescribed the medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile.
... performer 0..*BackboneElementWho performed the dispense event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: MedicationDispense Performer Function Codes (example)
.... actor 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Individual or device performing the dispense
... location 0..1Reference(US Core Location Profile)Where the dispense occurred
... authorizingPrescription 0..*Reference(US Core MedicationRequest Profile)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityBilling, service, product, or drug code
... daysSupply 0..1SimpleQuantityMedication expressed as a timing amount.
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient | Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution S0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted S1..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): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.


.... responsibleParty 0..*Reference(Practitioner | PractitionerRole)Who is responsible for the substitution
... detectedIssue 0..*Reference(DetectedIssue)Clinical issue with action
... eventHistory 0..*Reference(Provenance)A list of relevant lifecycle events

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*MedicationDispenseDispensing a medication to a named patient
... status ?!Σ1..1codecompleted
Binding: MedicationDispense Status Codes (required)
... subject Σ1..1Reference(US Core Patient Profile)The patient who is prescribed the medication
... substitution 0..1BackboneElementWhether a substitution was performed on the dispense
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense

doco Documentation for this format

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispenseDispensing a medication to a named patient
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... DispenseRefill 0..1QuantityRefill number of this prescription
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill
.... valueQuantity 0..1QuantityRefill number of this prescription
... status S1..1codecompleted
Binding: MedicationDispense Status Codes (required)
... medicationCodeableConcept 1..1CodeableConceptBilling, service, product, or drug code
Binding: FDA National Drug Code (NDC) (required)
... subject S1..1Reference(US Core Patient Profile)The patient who is prescribed the medication
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile.
... performer 0..*BackboneElementWho performed the dispense event
.... function 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: MedicationDispense Performer Function Codes (example)
.... actor 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Individual or device performing the dispense
... location 0..1Reference(US Core Location Profile)Where the dispense occurred
... authorizingPrescription 0..*Reference(US Core MedicationRequest Profile)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityBilling, service, product, or drug code
... daysSupply 0..1SimpleQuantityMedication expressed as a timing amount.
... substitution S0..1BackboneElementWhether a substitution was performed on the dispense
.... wasSubstituted S1..1booleanWhether a substitution was or was not performed on the dispense

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*MedicationDispenseDispensing a medication to a named patient
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... DispenseRefill 0..1QuantityRefill number of this prescription
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/DispenseRefill"
.... value[x] 0..1(Slice Definition)Refill number of this prescription
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 0..1QuantityRefill number of this prescription
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... partOf 0..*Reference(Procedure)Event that dispense is part of
... status ?!SΣ1..1codecompleted
Binding: MedicationDispense Status Codes (required)
... statusReason[x] 0..1Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConceptType of dispense action
Binding: MedicationDispense Category Codes (required)
... medication[x] Σ1..1(Slice Definition)What medication was supplied
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medication[x]:medicationCodeableConcept Σ1..1CodeableConceptBilling, service, product, or drug code
Binding: FDA National Drug Code (NDC) (required)
... subject SΣ1..1Reference(US Core Patient Profile)The patient who is prescribed the medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile.
... performer 0..*BackboneElementWho performed the dispense event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: MedicationDispense Performer Function Codes (example)
.... actor 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Individual or device performing the dispense
... location 0..1Reference(US Core Location Profile)Where the dispense occurred
... authorizingPrescription 0..*Reference(US Core MedicationRequest Profile)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityBilling, service, product, or drug code
... daysSupply 0..1SimpleQuantityMedication expressed as a timing amount.
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient | Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*DosageHow the medication is to be used by the patient or administered by the caregiver
... substitution S0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... wasSubstituted S1..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): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.


.... responsibleParty 0..*Reference(Practitioner | PractitionerRole)Who is responsible for the substitution
... detectedIssue 0..*Reference(DetectedIssue)Clinical issue with action
... eventHistory 0..*Reference(Provenance)A list of relevant lifecycle events

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
MedicationDispense.languagepreferredCommonLanguages
Max Binding: AllLanguages
MedicationDispense.statusrequiredMedicationDispense Status Codes
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
MedicationDispense.categoryrequiredMedicationDispense Category Codes
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
MedicationDispense.medication[x]:medicationCodeableConceptrequiredFDANationalDrugCode
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
MedicationDispense.typeexampleActPharmacySupplyType
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason