This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
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#> BASE <http://hl7.org/fhir/shape/> start=<MedicationAdministration> AND {fhir:nodeRole [fhir:treeRoot]} # Administration of medication to a patient <MedicationAdministration> CLOSED { a [fhir:MedicationAdministration]; fhir:nodeRole [fhir:treeRoot]?; fhir:Resource.id @<id>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:DomainResource.text @<Narrative>?; # Text summary of the resource, for # human interpretation fhir:DomainResource.contained @<Resource>*; # Contained, inline Resources fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:MedicationAdministration.identifier @<Identifier>*; # External identifier fhir:MedicationAdministration.status @<code> AND {fhir:value @fhirvs:medication-admin-status}; # in-progress | on-hold | completed # | entered-in-error | stopped ( # What was administered fhir:MedicationAdministration.medicationCodeableConcept @<CodeableConcept> | fhir:MedicationAdministration.medicationReference @<MedicationReference> ); fhir:MedicationAdministration.patient @<PatientReference>; # Who received medication fhir:MedicationAdministration.encounter @<EncounterReference>?; # Encounter administered as part of ( # Start and end time of # administration fhir:MedicationAdministration.effectiveTimeDateTime @<dateTime> | fhir:MedicationAdministration.effectiveTimePeriod @<Period> ); fhir:MedicationAdministration.performer # Who administered substance ( @<PractitionerReference> OR @<PatientReference> OR @<RelatedPersonReference> )?; fhir:MedicationAdministration.prescription @<MedicationOrderReference>?; # Order administration performed # against fhir:MedicationAdministration.wasNotGiven @<boolean>?; # True if medication not administered fhir:MedicationAdministration.reasonNotGiven @<CodeableConcept>*; # Reason administration not performed fhir:MedicationAdministration.reasonGiven @<CodeableConcept>*; # Reason administration performed fhir:MedicationAdministration.device @<DeviceReference>*; # Device used to administer fhir:MedicationAdministration.note @<Annotation>*; # Information about the # administration fhir:MedicationAdministration.dosage @<MedicationAdministration.dosage>?; # Details of how medication was taken fhir:MedicationAdministration.eventHistory @<MedicationAdministration.eventHistory>*; # A list of events of interest in # the lifecycle fhir:index xsd:integer? # Relative position in a list } # A list of events of interest in the lifecycle <MedicationAdministration.eventHistory> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:MedicationAdministration.eventHistory.status @<code> AND {fhir:value @fhirvs:medication-admin-status}; # in-progress | on-hold | completed # | entered-in-error | stopped fhir:MedicationAdministration.eventHistory.action @<CodeableConcept>?; # Action taken (e.g. verify) fhir:MedicationAdministration.eventHistory.dateTime @<dateTime>; # The date at which the event # happened fhir:MedicationAdministration.eventHistory.actor @<PractitionerReference>?; # Who took the action fhir:MedicationAdministration.eventHistory.reason @<CodeableConcept>?; # Reason the action was taken fhir:index xsd:integer? # Relative position in a list } # Details of how medication was taken <MedicationAdministration.dosage> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:MedicationAdministration.dosage.text @<string>?; # Free text dosage instructions e.g. # SIG ( # Body site administered to fhir:MedicationAdministration.dosage.siteCodeableConcept @<CodeableConcept> | fhir:MedicationAdministration.dosage.siteReference @<BodySiteReference> )?; fhir:MedicationAdministration.dosage.route @<CodeableConcept>?; # Path of substance into body fhir:MedicationAdministration.dosage.method @<CodeableConcept>?; # How drug was administered fhir:MedicationAdministration.dosage.dose @<SimpleQuantity>?; # Amount of medication per dose ( # Dose quantity per unit of time fhir:MedicationAdministration.dosage.rateRatio @<Ratio> | fhir:MedicationAdministration.dosage.rateQuantity @<SimpleQuantity> )?; fhir:index xsd:integer? # Relative position in a list } #---------------------- Data Types ------------------- # Primitive Type dateTime <dateTime> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime?; # Primitive value for dateTime fhir:index xsd:integer? # Relative position in a list } # Metadata about a resource <Meta> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Meta.versionId @<id>?; # Version specific identifier fhir:Meta.lastUpdated @<instant>?; # When the resource version last # changed fhir:Meta.profile @<uri>*; # Profiles this resource claims to # conform to fhir:Meta.security @<Coding>*; # Security Labels applied to this # resource fhir:Meta.tag @<Coding>*; # Tags applied to this resource fhir:index xsd:integer? # Relative position in a list } # Primitive Type code <code> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for code fhir:index xsd:integer? # Relative position in a list } # Primitive Type string <string> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string MAXLENGTH 1048576?; # Primitive value for string fhir:index xsd:integer? # Relative position in a list } # Base Resource <Resource> {a .+; fhir:Resource.id @<id>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:index xsd:integer? } # A fixed quantity (no comparator) <SimpleQuantity> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Time range defined by start and end date/time <Period> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Period.start @<dateTime>?; # Starting time with inclusive # boundary fhir:Period.end @<dateTime>?; # End time with inclusive boundary, # if not ongoing fhir:index xsd:integer? # Relative position in a list } # Primitive Type uri <uri> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for uri fhir:index xsd:integer? # Relative position in a list } # Text node with attribution <Annotation> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations ( # Individual responsible for the # annotation fhir:Annotation.authorReference @<PractitionerReference> | fhir:Annotation.authorReference @<PatientReference> | fhir:Annotation.authorReference @<RelatedPersonReference> | fhir:Annotation.authorString @<string> )?; fhir:Annotation.time @<dateTime>?; # When the annotation was made fhir:Annotation.text @<string>; # The annotation - text content fhir:index xsd:integer? # Relative position in a list } <Extension> {fhir:extension @<Extension>*; fhir:index xsd:integer? } # An identifier intended for computation <Identifier> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Identifier.use @<code> AND {fhir:value @fhirvs:identifier-use}?; # usual | official | temp | # secondary (If known) fhir:Identifier.type @<CodeableConcept>?; # Description of identifier fhir:Identifier.system @<uri>?; # The namespace for the identifier fhir:Identifier.value @<string>?; # The value that is unique fhir:Identifier.period @<Period>?; # Time period when id is/was valid # for use fhir:Identifier.assigner @<OrganizationReference>?; # Organization that issued id (may # be just text) fhir:index xsd:integer? # Relative position in a list } # Primitive Type boolean <boolean> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:boolean?; # Primitive value for boolean fhir:index xsd:integer? # Relative position in a list } # A human-readable formatted text, including images <Narrative> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Narrative.status @<code> AND {fhir:value @fhirvs:narrative-status}; # generated | extensions | # additional | empty fhir:Narrative.div xsd:string; # Limited xhtml content fhir:index xsd:integer? # Relative position in a list } # A ratio of two Quantity values - a numerator and a denominator <Ratio> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Ratio.numerator @<Quantity>?; # Numerator value fhir:Ratio.denominator @<Quantity>?; # Denominator value fhir:index xsd:integer? # Relative position in a list } # Primitive Type id <id> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for id fhir:index xsd:integer? # Relative position in a list } # Concept - reference to a terminology or just text <CodeableConcept> CLOSED { fhir:concept IRI*; fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:CodeableConcept.coding @<Coding>*; # Code defined by a terminology # system fhir:CodeableConcept.text @<string>?; # Plain text representation of the # concept fhir:index xsd:integer? # Relative position in a list } # A measured or measurable amount <Quantity> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.comparator @<code> AND {fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to # understand the value fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Primitive Type instant <instant> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:dateTime?; # Primitive value for instant fhir:index xsd:integer? # Relative position in a list } # A reference to a code defined by a terminology system <Coding> CLOSED { fhir:concept IRI?; fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Coding.system @<uri>?; # Identity of the terminology system fhir:Coding.version @<string>?; # Version of the system - if relevant fhir:Coding.code @<code>?; # Symbol in syntax defined by the # system fhir:Coding.display @<string>?; # Representation defined by the # system fhir:Coding.userSelected @<boolean>?; # If this coding was chosen directly # by the user fhir:index xsd:integer? # Relative position in a list } # Primitive Type decimal <decimal> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:decimal?; # Primitive value for decimal fhir:index xsd:integer? # Relative position in a list } #---------------------- Reference Types ------------------- <PractitionerReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Practitioner> OR CLOSED {a fhir:Practitioner}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <OrganizationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Organization> OR CLOSED {a fhir:Organization}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <DeviceReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Device> OR CLOSED {a fhir:Device}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <MedicationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Medication> OR CLOSED {a fhir:Medication}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <PatientReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Patient> OR CLOSED {a fhir:Patient}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <EncounterReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Encounter> OR CLOSED {a fhir:Encounter}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <MedicationOrderReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<MedicationOrder> OR CLOSED {a fhir:MedicationOrder}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <RelatedPersonReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<RelatedPerson> OR CLOSED {a fhir:RelatedPerson}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <BodySiteReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<BodySite> OR CLOSED {a fhir:BodySite}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } #---------------------- Value Sets ------------------------ # The status of a resource narrative @fhirvs:narrative-status = ["generated" "extensions" "additional" "empty"] # How the Quantity should be understood and represented. @fhirvs:quantity-comparator = ["<" "<=" ">=" ">"] # A set of codes indicating the current status of a MedicationAdministration. @fhirvs:medication-admin-status = ["in-progress" "on-hold" "completed" "entered-in-error" "stopped"] # Identifies the purpose for this identifier, if known . @fhirvs:identifier-use = ["usual" "official" "temp" "secondary"]
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.