Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Medicationadministration.shex

Pharmacy Work Group Maturity Level : N/A Standards Status : Informative Compartments : Encounter , Patient

Raw ShEx

ShEx statement for medicationadministration 

PREFIX fhir: <http://hl7.org/fhir/> 
PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> 
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> 
IMPORT <code.shex>
IMPORT <Group.shex>
IMPORT <Ratio.shex>
IMPORT <Period.shex>
IMPORT <Timing.shex>
IMPORT <string.shex>
IMPORT <Patient.shex>
IMPORT <boolean.shex>
IMPORT <dateTime.shex>
IMPORT <Quantity.shex>
IMPORT <CarePlan.shex>
IMPORT <Resource.shex>
IMPORT <Reference.shex>
IMPORT <Encounter.shex>
IMPORT <Procedure.shex>
IMPORT <Identifier.shex>
IMPORT <Annotation.shex>
IMPORT <Provenance.shex>
IMPORT <DomainResource.shex>
IMPORT <SimpleQuantity.shex>
IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>
IMPORT <CodeableReference.shex>
IMPORT <MedicationRequest.shex>
IMPORT <MedicationDispense.shex>
start=@<MedicationAdministration> AND {fhir:nodeRole [fhir:treeRoot]}
# Administration of medication to a patient
<MedicationAdministration> EXTENDS @<DomainResource> CLOSED {   
    a [fhir:MedicationAdministration]?;
    fhir:nodeRole [fhir:treeRoot]?;
    fhir:identifier @<OneOrMore_Identifier>?;  # External identifier
    fhir:basedOn @<OneOrMore_Reference_CarePlan>?;  # Plan this is fulfilled by this 
                                            # administration 
    fhir:partOf @<OneOrMore_Reference_MedicationAdministration_OR_MedicationDispense_OR_Procedure>?;  # Part of referenced event
    fhir:status @<code> AND
    	{fhir:v @fhirvs:medication-admin-status};  # in-progress | not-done | on-hold | 
                                            # completed | entered-in-error | 
                                            # stopped | unknown 
    fhir:statusReason @<OneOrMore_CodeableConcept>?;  # Reason administration not performed
    fhir:category @<OneOrMore_CodeableConcept>?;  # Type of medication administration
    fhir:medication @<CodeableReference>;   # What was administered
    fhir:subject @<Reference> AND {fhir:link 
    			@<Group> OR 
    			@<Patient> ? };  # Who received medication
    fhir:encounter @<Reference> AND {fhir:link 
    			@<Encounter> ? }?;  # Encounter administered as part of
    fhir:supportingInformation @<OneOrMore_Reference_Resource>?;  # Additional information to support 
                                            # administration 
    fhir:occurence @<dateTime>  OR 
    			@<Period>  OR 
    			@<Timing>  ;  # Specific date/time or interval of 
                                            # time during which the 
                                            # administration took place (or did 
                                            # not take place) 
    fhir:recorded @<dateTime>?;             # When the MedicationAdministration 
                                            # was first captured in the 
                                            # subject's record 
    fhir:isSubPotent @<boolean>?;           # Full dose was not administered
    fhir:subPotentReason @<OneOrMore_CodeableConcept>?;  # Reason full dose was not 
                                            # administered 
    fhir:performer @<OneOrMore_MedicationAdministration.performer>?;  # Who or what performed the 
                                            # medication administration and what 
                                            # type of performance they did 
    fhir:reason @<OneOrMore_CodeableReference>?;  # Concept, condition or observation 
                                            # that supports why the medication 
                                            # was administered 
    fhir:request @<Reference> AND {fhir:link 
    			@<MedicationRequest> ? }?;  # Request administration performed 
                                            # against 
    fhir:device @<OneOrMore_CodeableReference>?;  # Device used to administer
    fhir:note @<OneOrMore_Annotation>?;     # Information about the 
                                            # administration 
    fhir:dosage @<MedicationAdministration.dosage>?;  # Details of how medication was taken
    fhir:eventHistory @<OneOrMore_Reference_Provenance>?;  # A list of events of interest in 
                                            # the lifecycle 
}  
# Details of how medication was taken
<MedicationAdministration.dosage> EXTENDS @<BackboneElement> CLOSED {   
    fhir:text @<string>?;                   # Free text dosage instructions e.g. 
                                            # SIG 
    fhir:site @<CodeableConcept>?;          # Body site administered to
    fhir:route @<CodeableConcept>?;         # Path of substance into body
    fhir:method @<CodeableConcept>?;        # How drug was administered
    fhir:dose @<Quantity>?;                 # Amount of medication per dose
    fhir:rate @<Ratio>  OR 
    			@<SimpleQuantity>  ?;  # Dose quantity per unit of time
}  
# Who or what performed the medication administration and what type of performance they did
<MedicationAdministration.performer> EXTENDS @<BackboneElement> CLOSED {   
    fhir:function @<CodeableConcept>?;      # Type of performance
    fhir:actor @<CodeableReference>;        # Who or what performed the 
                                            # medication administration 
}  
#---------------------- Cardinality Types (OneOrMore) -------------------
<OneOrMore_Identifier> CLOSED {
    rdf:first @<Identifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> 
}
<OneOrMore_Reference_CarePlan> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<CarePlan> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_CarePlan> 
}
<OneOrMore_Reference_MedicationAdministration_OR_MedicationDispense_OR_Procedure> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<MedicationAdministration> OR 
			@<MedicationDispense> OR 
			@<Procedure> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_MedicationAdministration_OR_MedicationDispense_OR_Procedure> 
}
<OneOrMore_CodeableConcept> CLOSED {
    rdf:first @<CodeableConcept>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept> 
}
<OneOrMore_Reference_Resource> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<Resource> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Resource> 
}
<OneOrMore_MedicationAdministration.performer> CLOSED {
    rdf:first @<MedicationAdministration.performer>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MedicationAdministration.performer> 
}
<OneOrMore_CodeableReference> CLOSED {
    rdf:first @<CodeableReference>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableReference> 
}
<OneOrMore_Annotation> CLOSED {
    rdf:first @<Annotation>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Annotation> 
}
<OneOrMore_Reference_Provenance> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<Provenance> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Provenance> 
}
#---------------------- Value Sets ------------------------
# MedicationAdministration Status Codes
fhirvs:medication-admin-status ["in-progress" "not-done" "on-hold" "completed" "entered-in-error" "stopped" "unknown"]

PREFIX fhir: <http://hl7.org/fhir/> 
PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> 
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> 

IMPORT <code.shex>
IMPORT <Group.shex>
IMPORT <Ratio.shex>
IMPORT <Period.shex>
IMPORT <Timing.shex>
IMPORT <string.shex>
IMPORT <Patient.shex>
IMPORT <boolean.shex>
IMPORT <dateTime.shex>
IMPORT <Quantity.shex>
IMPORT <CarePlan.shex>
IMPORT <Resource.shex>
IMPORT <Reference.shex>
IMPORT <Encounter.shex>
IMPORT <Procedure.shex>
IMPORT <Identifier.shex>
IMPORT <Annotation.shex>
IMPORT <Provenance.shex>
IMPORT <DomainResource.shex>
IMPORT <SimpleQuantity.shex>
IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>
IMPORT <CodeableReference.shex>
IMPORT <MedicationRequest.shex>
IMPORT <MedicationDispense.shex>


start=@<MedicationAdministration> AND {fhir:nodeRole [fhir:treeRoot]}

# Administration of medication to a patient
<MedicationAdministration> EXTENDS @<DomainResource> CLOSED {   

    a [fhir:MedicationAdministration]?;
    fhir:nodeRole [fhir:treeRoot]?;

    fhir:identifier @<OneOrMore_Identifier>?;  # External identifier
    fhir:basedOn @<OneOrMore_Reference_CarePlan>?;  # Plan this is fulfilled by this 
                                            # administration 
    fhir:partOf @<OneOrMore_Reference_MedicationAdministration_OR_MedicationDispense_OR_Procedure>?;  # Part of referenced event
    fhir:status @<code> AND
    	{fhir:v @fhirvs:medication-admin-status};  # in-progress | not-done | on-hold | 
                                            # completed | entered-in-error | 
                                            # stopped | unknown 
    fhir:statusReason @<OneOrMore_CodeableConcept>?;  # Reason administration not performed
    fhir:category @<OneOrMore_CodeableConcept>?;  # Type of medication administration
    fhir:medication @<CodeableReference>;   # What was administered
    fhir:subject @<Reference> AND {fhir:link 
    			@<Group> OR 
    			@<Patient> ? };  # Who received medication
    fhir:encounter @<Reference> AND {fhir:link 
    			@<Encounter> ? }?;  # Encounter administered as part of
    fhir:supportingInformation @<OneOrMore_Reference_Resource>?;  # Additional information to support 
                                            # administration 
    fhir:occurence @<dateTime>  OR 
    			@<Period>  OR 
    			@<Timing>  ;  # Specific date/time or interval of 
                                            # time during which the 
                                            # administration took place (or did 
                                            # not take place) 
    fhir:recorded @<dateTime>?;             # When the MedicationAdministration 
                                            # was first captured in the 
                                            # subject's record 
    fhir:isSubPotent @<boolean>?;           # Full dose was not administered
    fhir:subPotentReason @<OneOrMore_CodeableConcept>?;  # Reason full dose was not 
                                            # administered 
    fhir:performer @<OneOrMore_MedicationAdministration.performer>?;  # Who or what performed the 
                                            # medication administration and what 
                                            # type of performance they did 
    fhir:reason @<OneOrMore_CodeableReference>?;  # Reason that supports why the 
                                            # medication was administered 
    fhir:request @<Reference> AND {fhir:link 
    			@<MedicationRequest> ? }?;  # Request administration performed 
                                            # against 
    fhir:device @<OneOrMore_CodeableReference>?;  # Device used to administer
    fhir:note @<OneOrMore_Annotation>?;     # Information about the 
                                            # administration 
    fhir:dosage @<MedicationAdministration.dosage>?;  # Details of how medication was taken
    fhir:eventHistory @<OneOrMore_Reference_Provenance>?;  # A list of events of interest in 
                                            # the lifecycle 
}  

# Details of how medication was taken
<MedicationAdministration.dosage> EXTENDS @<BackboneElement> CLOSED {   
    fhir:text @<string>?;                   # Free text dosage instructions e.g. 
                                            # SIG 
    fhir:site @<CodeableConcept>?;          # Body site administered to
    fhir:route @<CodeableConcept>?;         # Path of substance into body
    fhir:method @<CodeableConcept>?;        # How drug was administered
    fhir:dose @<Quantity>?;                 # Amount of medication per dose
    fhir:rate @<Ratio>  OR 
    			@<SimpleQuantity>  ?;  # Dose quantity per unit of time
}  

# Who or what performed the medication administration and what type of performance they did
<MedicationAdministration.performer> EXTENDS @<BackboneElement> CLOSED {   
    fhir:function @<CodeableConcept>?;      # Type of performance
    fhir:actor @<CodeableReference>;        # Who or what performed the 
                                            # medication administration 
}  

#---------------------- Cardinality Types (OneOrMore) -------------------

<OneOrMore_Identifier> CLOSED {
    rdf:first @<Identifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> 
}

<OneOrMore_Reference_CarePlan> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<CarePlan> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_CarePlan> 
}

<OneOrMore_Reference_MedicationAdministration_OR_MedicationDispense_OR_Procedure> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<MedicationAdministration> OR 
			@<MedicationDispense> OR 
			@<Procedure> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_MedicationAdministration_OR_MedicationDispense_OR_Procedure> 
}

<OneOrMore_CodeableConcept> CLOSED {
    rdf:first @<CodeableConcept>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept> 
}

<OneOrMore_Reference_Resource> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<Resource> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Resource> 
}

<OneOrMore_MedicationAdministration.performer> CLOSED {
    rdf:first @<MedicationAdministration.performer>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MedicationAdministration.performer> 
}

<OneOrMore_CodeableReference> CLOSED {
    rdf:first @<CodeableReference>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableReference> 
}

<OneOrMore_Annotation> CLOSED {
    rdf:first @<Annotation>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Annotation> 
}

<OneOrMore_Reference_Provenance> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<Provenance> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Provenance> 
}

#---------------------- Value Sets ------------------------

# MedicationAdministration Status Codes
fhirvs:medication-admin-status ["in-progress" "not-done" "on-hold" "completed" "entered-in-error" "stopped" "unknown"]

Usage note: every effort has been made to ensure that the ShEx files are correct and useful, but they are not a normative part of the specification.