International Patient Summary Implementation Guide Implementation Guide: STU2 Ballot

This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

SD.12 StructureDefinition-medicationstatement-uv-ips

This profile represents the constraints applied to the MedicationStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A record of a medication statement is represented in the patient summary as an instance of a MedicationStatement resource constrained by this profile.

Conformance resource variables defined here

SD.12.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/medicationstatement-uv-ips

Published on Thu Feb 15 07:57:06 AEST 2018 as a draft by HL7 International.

This profile builds on MedicationStatement

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... data-absent-reason S0..*codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... basedOn 0..*Reference(MedicationRequest | CarePlan | ServiceRequest)
.... identifier 0..0
... partOf 0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)
.... identifier 0..0
... status S1..1code
... category 0..1CodeableConcept-uv-ips
... medication[x] S1..1CodeableConcept-uv-ips, Reference(Medication)Binding: Absent or Unknown Medication (required)
... subject 1..1Reference(Patient)
.... identifier 0..0
... context 0..1Reference(Encounter | EpisodeOfCare)
.... identifier 0..0
... effective[x] S0..1dateTime, Period
... informationSource 0..1Reference(Patient | Practitioner | RelatedPerson | Organization)
.... identifier 0..0
... derivedFrom 0..*Reference(Resource)
.... identifier 0..0
... reasonCode 0..*CodeableConcept-uv-ips
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)
.... identifier 0..0
... dosage S0..*Dosage
.... text S0..1string
.... additionalInstruction 0..*CodeableConcept-uv-ips
.... patientInstruction S0..1string
.... timing S0..1Timing
..... repeat 0..1Element
...... bounds[x] 0..1Duration, Period, Range-uv-ips
..... code 0..1CodeableConcept-uv-ips
...... coding 0..*coding-uv-ips
....... system 0..1uriBinding: EventTiming (example)
.... site 0..1CodeableConcept-uv-ips
..... coding 0..*coding-uv-ipsBinding: IPS Target Site (preferred)
...... system 0..1uriBinding: IPS Target Site (preferred)
.... route S0..1CodeableConcept-uv-ips
..... coding 0..*coding-uv-ipsBinding: Medicine Route of Administration (preferred)
...... system 0..1uriBinding: Medicine Route of Administration (preferred)
.... method 0..1CodeableConcept-uv-ips
.... doseAndRate 0..*Element
..... rateQuantity 0..0
.... maxDosePerPeriod 0..0
.... maxDosePerAdministration 0..0
.... maxDosePerLifetime 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*Record of medication being taken by a 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 (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... data-absent-reason SI0..*codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... basedOn Σ0..*Reference(MedicationRequest | CarePlan | ServiceRequest)Fulfils plan, proposal or order
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)Part of referenced event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... status ?!SΣ1..1codeactive | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: MedicationStatementStatus (required)
... statusReason 0..*CodeableConceptReason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example)
... category I0..1CodeableConcept-uv-ipsType of medication usage
Binding: MedicationStatementCategory (preferred)
... medication[x] SΣ1..1CodeableConcept-uv-ips, Reference(Medication)What medication was taken
Binding: Absent or Unknown Medication (required)
... subject Σ1..1Reference(Patient)Who is/was taking the medication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... context Σ0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with MedicationStatement
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... effective[x] SΣ0..1dateTime, PeriodThe date/time or interval when the medication is/was/will taken
... dateAsserted Σ0..1dateTimeWhen the statement was asserted?
... informationSource 0..1Reference(Patient | Practitioner | RelatedPerson | Organization)Person or organization that provided the information about the taking of this medication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... derivedFrom 0..*Reference(Resource)Additional supporting information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... reasonCode I0..*CodeableConcept-uv-ipsReason for why the medication is being/was taken
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication is being/was taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... note 0..*AnnotationFurther information about the statement
... dosage S0..*DosageDetails of how medication is/was taken or should be taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... sequence Σ0..1integerThe order of the dosage instructions
.... text SΣ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction I0..*CodeableConcept-uv-ipsSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction SΣ0..1stringPatient or consumer oriented instructions
.... timing SΣ0..1TimingWhen medication should be administered
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... event Σ0..*dateTimeWhen the event occurs
..... repeat ΣI0..1ElementWhen the event is to occur
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ0..1Duration, Period, Range-uv-ipsLength/Range of lengths, or (Start and/or end) limits
...... count Σ0..1positiveIntNumber of times to repeat
...... countMax Σ0..1positiveIntMaximum number of times to repeat
...... duration Σ0..1decimalHow long when it happens
...... durationMax Σ0..1decimalHow long when it happens (Max)
...... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ0..1positiveIntEvent occurs frequency times per period
...... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
...... period Σ0..1decimalEvent occurs frequency times per period
...... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ0..*timeTime of day for action
...... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required)
...... offset Σ0..1unsignedIntMinutes from event (before or after)
..... code I0..1CodeableConcept-uv-ipsBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*coding-uv-ipsCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Binding: EventTiming (example)
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
........ value 0..1Primitive value for string
Max Length: 1048576
...... text Σ0..1stringPlain text representation of the concept
.... asNeeded[x] Σ0..1boolean, CodeableConceptTake "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... site I0..1CodeableConcept-uv-ipsBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*coding-uv-ipsCode defined by a terminology system
Binding: IPS Target Site (preferred)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Binding: IPS Target Site (preferred)
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... value 0..1Primitive value for string
Max Length: 1048576
..... text Σ0..1stringPlain text representation of the concept
.... route SI0..1CodeableConcept-uv-ipsHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*coding-uv-ipsCode defined by a terminology system
Binding: Medicine Route of Administration (preferred)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Binding: Medicine Route of Administration (preferred)
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... value 0..1Primitive value for string
Max Length: 1048576
..... text Σ0..1stringPlain text representation of the concept
.... method I0..1CodeableConcept-uv-ipsTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate ΣI0..*ElementAmount of medication administered
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ1..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... dose[x] Σ0..1Range, SimpleQuantityAmount of medication per dose

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron