This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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 medicationstatement
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=@<MedicationStatement> AND {fhir:nodeRole [fhir:treeRoot]} # Record of medication being taken by a patient <MedicationStatement> CLOSED { a [fhir:MedicationStatement]; 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:MedicationStatement.identifier @<Identifier>*; # External identifier fhir:MedicationStatement.status @<code> AND {fhir:value @fhirvs:medication-statement-status}; # active | completed | # entered-in-error | intended | # stopped | on-hold ( # What medication was taken fhir:MedicationStatement.medicationCodeableConcept @<CodeableConcept> | fhir:MedicationStatement.medicationReference @<Reference> ); fhir:MedicationStatement.subject # Who is/was taking the medication ( @<PatientReference> OR @<GroupReference> ); ( # Over what period was medication # consumed? fhir:MedicationStatement.effectiveDateTime @<dateTime> | fhir:MedicationStatement.effectivePeriod @<Period> )?; fhir:MedicationStatement.informationSource # Person or organization that # provided the information about the # taking of this medication ( @<PatientReference> OR @<PractitionerReference> OR @<RelatedPersonReference> OR @<OrganizationReference> )?; fhir:MedicationStatement.derivedFrom @<Reference>*; # Additional supporting information fhir:MedicationStatement.dateAsserted @<dateTime>?; # When the statement was asserted? fhir:MedicationStatement.notTaken @<code> AND {fhir:value @fhirvs:medication-statement-nottaken}?; # y | n | unk fhir:MedicationStatement.reasonNotTaken @<CodeableConcept>*; # True if asserting medication was # not given fhir:MedicationStatement.reasonForUseCodeableConcept @<CodeableConcept>*; # Reason for why the medication is # being/was taken fhir:MedicationStatement.reasonForUseReference # Condition or observation that # supports why the medication is # being/was taken ( @<ConditionReference> OR @<ObservationReference> )*; fhir:MedicationStatement.note @<Annotation>*; # Further information about the # statement fhir:MedicationStatement.category @<code>?; # Type of medication usage fhir:MedicationStatement.dosage @<DosageInstruction>*; # Details of how medication was taken fhir:index xsd:integer? # Relative position in a list } #---------------------- Data Types ------------------- # Primitive Type dateTime <dateTime> CLOSED { fhir:Element.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 } # A reference from one resource to another <Reference> CLOSED { fhir:link IRI?; fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Reference.reference @<string>?; # Literal reference, Relative, # internal or absolute URL fhir:Reference.identifier @<Identifier>?; # Logical reference, when literal # reference is not known fhir:Reference.display @<string>?; # Text alternative for the resource 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? } # 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:Element.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 @<Reference> | fhir:Annotation.authorReference @<Reference> | fhir:Annotation.authorReference @<Reference> | 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 @<Reference>?; # Organization that issued id (may # be just text) 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 } # 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 } # How medication should be taken <DosageInstruction> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:DosageInstruction.sequence @<integer>?; # The order of the dosage # instructions fhir:DosageInstruction.text @<string>?; # Free text dosage instructions e.g. # SIG fhir:DosageInstruction.additionalInstructions @<CodeableConcept>*; # Supplemental instructions - e.g. # "with meals" fhir:DosageInstruction.timing @<Timing>?; # When medication should be # administered ( # Take "as needed" (for x) fhir:DosageInstruction.asNeededBoolean @<boolean> | fhir:DosageInstruction.asNeededCodeableConcept @<CodeableConcept> )?; fhir:DosageInstruction.site @<CodeableConcept>?; # Body site to administer to fhir:DosageInstruction.route @<CodeableConcept>?; # How drug should enter body fhir:DosageInstruction.method @<CodeableConcept>?; # Technique for administering # medication ( # Amount of medication per dose fhir:DosageInstruction.doseRange @<Range> | fhir:DosageInstruction.doseQuantity @<SimpleQuantity> )?; fhir:DosageInstruction.maxDosePerPeriod @<Ratio>?; # Upper limit on medication per unit # of time fhir:DosageInstruction.maxDosePerAdministration @<SimpleQuantity>?; # Upper limit on medication per # administration fhir:DosageInstruction.maxDosePerLifetime @<SimpleQuantity>?; # Upper limit on medication per # lifetime of the patient ( # Amount of medication per unit of # time fhir:DosageInstruction.rateRatio @<Ratio> | fhir:DosageInstruction.rateRange @<Range> | fhir:DosageInstruction.rateQuantity @<SimpleQuantity> )?; fhir:index xsd:integer? # Relative position in a list } # Primitive Type string <string> CLOSED { fhir:Element.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 } # 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 } # Primitive Type integer <integer> CLOSED { fhir:Element.id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:int MININCLUSIVE "-2147483648"^^xsd:int MAXINCLUSIVE "2147483647"^^xsd:int?; # Primitive value for integer fhir:index xsd:integer? # Relative position in a list } # Set of values bounded by low and high <Range> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Range.low @<SimpleQuantity>?; # Low limit fhir:Range.high @<SimpleQuantity>?; # High limit fhir:index xsd:integer? # Relative position in a list } # Primitive Type instant <instant> CLOSED { fhir:Element.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 } # Primitive Type boolean <boolean> CLOSED { fhir:Element.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 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 } # 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 } # A timing schedule that specifies an event that may occur multiple times <Timing> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Timing.event @<dateTime>*; # When the event occurs fhir:Timing.repeat @<Timing.repeat>?; # When the event is to occur fhir:Timing.code @<CodeableConcept>?; # BID | TID | QID | AM | PM | QD | # QOD | Q4H | Q6H + 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 decimal <decimal> CLOSED { fhir:Element.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 } # When the event is to occur <Timing.repeat> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations ( # Length/Range of lengths, or (Start # and/or end) limits fhir:Timing.repeat.boundsDuration @<Duration> | fhir:Timing.repeat.boundsRange @<Range> | fhir:Timing.repeat.boundsPeriod @<Period> )?; fhir:Timing.repeat.count @<integer>?; # Number of times to repeat fhir:Timing.repeat.countMax @<integer>?; # Maximum number of times to repeat fhir:Timing.repeat.duration @<decimal>?; # How long when it happens fhir:Timing.repeat.durationMax @<decimal>?; # How long when it happens (Max) fhir:Timing.repeat.durationUnit @<code> AND {fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a - # unit of time (UCUM) fhir:Timing.repeat.frequency @<integer>?; # Event occurs frequency times per # period fhir:Timing.repeat.frequencyMax @<integer>?; # Event occurs up to frequencyMax # times per period fhir:Timing.repeat.period @<decimal>?; # Event occurs frequency times per # period fhir:Timing.repeat.periodMax @<decimal>?; # Upper limit of period (3-4 hours) fhir:Timing.repeat.periodUnit @<code> AND {fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a - # unit of time (UCUM) fhir:Timing.repeat.dayOfWeek @<code> AND {fhir:value @fhirvs:days-of-week}*; # mon | tue | wed | thu | fri | sat # | sun fhir:Timing.repeat.timeOfDay @<time>*; # Time of day for action fhir:Timing.repeat.when @<code> AND {fhir:value @fhirvs:event-timing}?; # Regular life events the event is # tied to fhir:Timing.repeat.offset @<unsignedInt>?; # Minutes from event (before or # after) fhir:index xsd:integer? # Relative position in a list } # A length of time <Duration> 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 unsignedInt <unsignedInt> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:nonNegativeInteger?; # Primitive value for unsignedInt fhir:index xsd:integer? # Relative position in a list } # Primitive Type time <time> CLOSED { fhir:Element.id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:time?; # Primitive value for time 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? } <Practitioner> { a [fhir:Practitioner]; fhir:nodeRole [fhir:treeRoot]? } <ConditionReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Condition> OR CLOSED {a fhir:Condition}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <Condition> { a [fhir:Condition]; fhir:nodeRole [fhir:treeRoot]? } <GroupReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Group> OR CLOSED {a fhir:Group}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <Group> { a [fhir:Group]; fhir:nodeRole [fhir:treeRoot]? } <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? } <Organization> { a [fhir:Organization]; fhir:nodeRole [fhir:treeRoot]? } <ObservationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Observation> OR CLOSED {a fhir:Observation}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <Observation> { a [fhir:Observation]; fhir:nodeRole [fhir:treeRoot]? } <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? } <Patient> { a [fhir:Patient]; fhir:nodeRole [fhir:treeRoot]? } <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? } <RelatedPerson> { a [fhir:RelatedPerson]; fhir:nodeRole [fhir:treeRoot]? } #---------------------- Value Sets ------------------------ # A coded concept indicating the current status of a MedicationStatement. fhirvs:medication-statement-status ["active" "completed" "entered-in-error" "intended" "stopped" "on-hold"] # A coded concept identifying level of certainty if patient has taken or has not taken the medication fhirvs:medication-statement-nottaken ["y" "n" "unk"] # The days of the week. fhirvs:days-of-week ["mon" "tue" "wed" "thu" "fri" "sat" "sun"] # A unit of time (units from UCUM). fhirvs:units-of-time ["s" "min" "h" "d" "wk" "mo" "a"] # How the Quantity should be understood and represented. fhirvs:quantity-comparator ["<" "<=" ">=" ">"] # The status of a resource narrative fhirvs:narrative-status ["generated" "extensions" "additional" "empty"] # Identifies the purpose for this identifier, if known . fhirvs:identifier-use ["usual" "official" "temp" "secondary"] # Real world event that the relating to the schedule. fhirvs:event-timing ["MORN" "AFT" "EVE" "NIGHT" "HS" "WAKE" "C" "CM" "CD" "CV" "AC" "ACM" "ACD" "ACV" "PC" "PCM" "PCD" "PCV"]
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.