Primary Care Implementation Guide

AU Primary Care Implementation Guide - Local Development build (vnull). See the Directory of published versions

1.0 StructureDefinition-au-primarycaremedicationstatement

AU Primary Care Medication Statement Profile [FMM Level 0]

This profile defines a medication statement structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

Examples thanks to Brett Esler - Oridashi .. not yet checked for conformance to this IG

Oridashi Sample Medication Statement 1

Oridashi Sample Medication Statement 2

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

https://aehrc.com/fhir/StructureDefinition/AUPrimaryCareMedicationStatement

This profile defines a medication statement structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

This profile builds on AUBaseMedicationStatement.

This profile was published on Wed Nov 06 14:07:15 AEST 2019 as a draft by null.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This profile contains the following variations from AU Base Medication Statement:

  1. medication.coded.coding:amt slice mustSupport
  2. reasonCode mustSupport
    • reasonCode.coding:snomedReasonCode slice mustSupport
    • ValueSet binding http://aehrc.com/valueset/clinical-indication-for-medication added
  3. note mustSupport
  4. dosage.additionaInstruction mustSupport
    • ValueSet binding with extensible binding strength
  5. dosage.timing.repeat.duration mustSupport
  6. dosage.timing.repeat.frequency mustSupport
  7. dosage.route mustSupport
    • ValueSet binding https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 added with extensible binding strength
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*A record of medication being taken by a patient in an Australian primary care practice-to-practice record transfer context.
... medication[x] 1..1
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(AU Primary Care Medication)
... note 0..*Annotation
.... text S1..1markdown
... dosage 0..*AUBaseDosage
.... additionalInstruction S0..*CodeableConcept
.... timing 0..1Timing
..... repeat
...... duration S0..1decimal
...... frequency S0..1positiveInt
...... period S0..1decimal
...... when S0..*code
.... asNeeded[x] S0..1boolean, CodeableConcept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*A record of medication being taken by a patient in an Australian primary care practice-to-practice record transfer context.
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... medication-long-term I0..1booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal identifier
... basedOn ΣI0..*Reference(MedicationRequest | CarePlan | ServiceRequest)Fulfils plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)Part of referenced event
... status ?!ΣI1..1codeactive | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required)
... statusReason I0..*CodeableConceptReason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example)
... category ΣI0..1CodeableConceptType of medication usage
Binding: Medication usage category codes (preferred)
... medication[x] ΣI1..1(Slice Definition)Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(AU Primary Care Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:amt ΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type I0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Medication Reference
... subject ΣI1..1Reference(Patient | Group)Who is/was taking the medication
... context ΣI0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with MedicationStatement
... effective[x] ΣI0..1The date/time or interval when the medication is/was/will be taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted ΣI0..1dateTimeWhen the statement was asserted?
... informationSource I0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)Person or organization that provided the information about the taking of this medication
... derivedFrom I0..*Reference(Resource)Additional supporting information
... reasonCode I0..*CodeableConceptReason for why the medication is being/was taken
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (preferred)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication is being/was taken
... note I0..*AnnotationFurther information about the statement
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] ΣI0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time ΣI0..1dateTimeWhen the annotation was made
.... text SΣI1..1markdownThe annotation - text content (as markdown)
... dosage I0..*AUBaseDosageDosage information in an Australian healthcare context
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence ΣI0..1integerThe order of the dosage instructions
.... text ΣI0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction SΣI0..*(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
Binding: SNOMEDCTAdditionalDosageInstructions (example)
..... additionalInstruction:snomedAdditionalInstruction ΣI0..*CodeableConceptSNOMED CT Additional Instruction
Binding: (unbound) (required)
.... patientInstruction ΣI0..1stringPatient or consumer oriented instructions
.... timing ΣI0..1TimingWhen medication should be administered
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... event ΣI0..*dateTimeWhen the event occurs
..... repeat ΣI0..1ElementWhen the event is to occur
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-4: duration SHALL be a non-negative value
tim-5: period SHALL be a non-negative value
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] ΣI0..1Length/Range of lengths, or (Start and/or end) limits
....... boundsDurationDuration
....... boundsRangeRange
....... boundsPeriodPeriod
...... count ΣI0..1positiveIntNumber of times to repeat
...... countMax ΣI0..1positiveIntMaximum number of times to repeat
...... duration SΣI0..1decimalHow long when it happens
...... durationMax ΣI0..1decimalHow long when it happens (Max)
...... durationUnit ΣI0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency SΣI0..1positiveIntEvent occurs frequency times per period
...... frequencyMax ΣI0..1positiveIntEvent occurs up to frequencyMax times per period
...... period SΣI0..1decimalEvent occurs frequency times per period
...... periodMax ΣI0..1decimalUpper limit of period (3-4 hours)
...... periodUnit ΣI0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek ΣI0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay ΣI0..*timeTime of day for action
...... when SΣI0..*codeCode for time period of occurrence
Binding: EventTiming (required)
...... offset ΣI0..1unsignedIntMinutes from event (before or after)
..... code ΣI0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
.... asNeeded[x] SΣI0..1(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
..... asNeeded[x]:asNeededCodeableConcept ΣI0..1CodeableConceptCoded Reason For Take "as needed"
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:snomedFinding ΣI0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
...... text ΣI0..1stringPlain text representation of the concept
.... site ΣI0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required)
..... text ΣI0..1stringPlain text representation of the concept
.... route ΣI0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedRoute ΣI0..1CodingRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required)
..... text ΣI0..1stringPlain text representation of the concept
.... method ΣI0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedMethod ΣI0..1CodingSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (required)
..... text ΣI0..1stringPlain text representation of the concept
.... doseAndRate ΣI0..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... dose[x] ΣI0..1Amount of medication per dose
...... doseRangeRange
...... doseQuantityQuantity(SimpleQuantity)
..... rate[x] ΣI0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod ΣI0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration ΣI0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime ΣI0..1SimpleQuantityUpper limit on medication per lifetime of the patient

doco Documentation for this format

This profile contains the following variations from AU Base Medication Statement:

  1. medication.coded.coding:amt slice mustSupport
  2. reasonCode mustSupport
    • reasonCode.coding:snomedReasonCode slice mustSupport
    • ValueSet binding http://aehrc.com/valueset/clinical-indication-for-medication added
  3. note mustSupport
  4. dosage.additionaInstruction mustSupport
    • ValueSet binding with extensible binding strength
  5. dosage.timing.repeat.duration mustSupport
  6. dosage.timing.repeat.frequency mustSupport
  7. dosage.route mustSupport
    • ValueSet binding https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 added with extensible binding strength

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*A record of medication being taken by a patient in an Australian primary care practice-to-practice record transfer context.
... medication[x] 1..1
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(AU Primary Care Medication)
... note 0..*Annotation
.... text S1..1markdown
... dosage 0..*AUBaseDosage
.... additionalInstruction S0..*CodeableConcept
.... timing 0..1Timing
..... repeat
...... duration S0..1decimal
...... frequency S0..1positiveInt
...... period S0..1decimal
...... when S0..*code
.... asNeeded[x] S0..1boolean, CodeableConcept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*A record of medication being taken by a patient in an Australian primary care practice-to-practice record transfer context.
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... medication-long-term I0..1booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal identifier
... basedOn ΣI0..*Reference(MedicationRequest | CarePlan | ServiceRequest)Fulfils plan, proposal or order
... partOf ΣI0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)Part of referenced event
... status ?!ΣI1..1codeactive | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required)
... statusReason I0..*CodeableConceptReason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example)
... category ΣI0..1CodeableConceptType of medication usage
Binding: Medication usage category codes (preferred)
... medication[x] ΣI1..1(Slice Definition)Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(AU Primary Care Medication)
.... medication[x]:medicationCodeableConcept ΣI0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:amt ΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medication-type I0..1CodingClass of Medication Coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version ΣI0..1stringVersion of the system - if relevant
....... code ΣI0..1codeSymbol in syntax defined by the system
....... display ΣI0..1stringRepresentation defined by the system
....... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... medication[x]:medicationReference ΣI0..1Reference(AU Base Medication)Medication Reference
... subject ΣI1..1Reference(Patient | Group)Who is/was taking the medication
... context ΣI0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with MedicationStatement
... effective[x] ΣI0..1The date/time or interval when the medication is/was/will be taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted ΣI0..1dateTimeWhen the statement was asserted?
... informationSource I0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)Person or organization that provided the information about the taking of this medication
... derivedFrom I0..*Reference(Resource)Additional supporting information
... reasonCode I0..*CodeableConceptReason for why the medication is being/was taken
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (preferred)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication is being/was taken
... note I0..*AnnotationFurther information about the statement
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] ΣI0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time ΣI0..1dateTimeWhen the annotation was made
.... text SΣI1..1markdownThe annotation - text content (as markdown)
... dosage I0..*AUBaseDosageDosage information in an Australian healthcare context
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence ΣI0..1integerThe order of the dosage instructions
.... text ΣI0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction SΣI0..*(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
Binding: SNOMEDCTAdditionalDosageInstructions (example)
..... additionalInstruction:snomedAdditionalInstruction ΣI0..*CodeableConceptSNOMED CT Additional Instruction
Binding: (unbound) (required)
.... patientInstruction ΣI0..1stringPatient or consumer oriented instructions
.... timing ΣI0..1TimingWhen medication should be administered
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... event ΣI0..*dateTimeWhen the event occurs
..... repeat ΣI0..1ElementWhen the event is to occur
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-4: duration SHALL be a non-negative value
tim-5: period SHALL be a non-negative value
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] ΣI0..1Length/Range of lengths, or (Start and/or end) limits
....... boundsDurationDuration
....... boundsRangeRange
....... boundsPeriodPeriod
...... count ΣI0..1positiveIntNumber of times to repeat
...... countMax ΣI0..1positiveIntMaximum number of times to repeat
...... duration SΣI0..1decimalHow long when it happens
...... durationMax ΣI0..1decimalHow long when it happens (Max)
...... durationUnit ΣI0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency SΣI0..1positiveIntEvent occurs frequency times per period
...... frequencyMax ΣI0..1positiveIntEvent occurs up to frequencyMax times per period
...... period SΣI0..1decimalEvent occurs frequency times per period
...... periodMax ΣI0..1decimalUpper limit of period (3-4 hours)
...... periodUnit ΣI0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek ΣI0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay ΣI0..*timeTime of day for action
...... when SΣI0..*codeCode for time period of occurrence
Binding: EventTiming (required)
...... offset ΣI0..1unsignedIntMinutes from event (before or after)
..... code ΣI0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred)
.... asNeeded[x] SΣI0..1(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
..... asNeeded[x]:asNeededCodeableConcept ΣI0..1CodeableConceptCoded Reason For Take "as needed"
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
....... coding:snomedFinding ΣI0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
...... text ΣI0..1stringPlain text representation of the concept
.... site ΣI0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required)
..... text ΣI0..1stringPlain text representation of the concept
.... route ΣI0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedRoute ΣI0..1CodingRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required)
..... text ΣI0..1stringPlain text representation of the concept
.... method ΣI0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedMethod ΣI0..1CodingSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (required)
..... text ΣI0..1stringPlain text representation of the concept
.... doseAndRate ΣI0..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... dose[x] ΣI0..1Amount of medication per dose
...... doseRangeRange
...... doseQuantityQuantity(SimpleQuantity)
..... rate[x] ΣI0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod ΣI0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration ΣI0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime ΣI0..1SimpleQuantityUpper limit on medication per lifetime of the patient

doco Documentation for this format

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

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-primarycaremedicationstatement

none defined