Medtech ALEX® Implementation Guide
0.0.1 - draft International flag

Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Repeat Prescription Post Bundle

Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/repeatprescription-post-bundle Version: 0.0.1
Active as of 2025-01-20 Computable Name: RepeatPrescriptionPostBundle

The Bundle payload for post of Repeat Prescription

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


ele-1: All FHIR elements must have a @value or children
Required Pattern: transaction
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entry:repeatprescription ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 AlexRepeatPrescription A request for a medication for a patient in an Australian healthcare context
...... id SΣ 1..1 id The ID of the existing medication to be repeated.
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... longTerm 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... scheme 0..1 Coding Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme
Binding: Medication Scheme (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... unusualDose 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... regulation24 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... approvedNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... authorityNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


ele-1: All FHIR elements must have a @value or children
Required Pattern: active
...... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.


ele-1: All FHIR elements must have a @value or children
Required Pattern: order
...... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
ele-1: All FHIR elements must have a @value or children
...... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.


ele-1: All FHIR elements must have a @value or children
....... medication[x]:medicationReference SΣ 0..1 Reference(Medication) Prescribed Medication
ele-1: All FHIR elements must have a @value or children
....... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.


ele-1: All FHIR elements must have a @value or children
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
......... coding:mimsPackage Σ 1..1 Coding MIMS Package
Binding: MIMS (preferred)
ele-1: All FHIR elements must have a @value or children
.......... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://www.mims.com.au/codes
.......... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
.......... display SΣ 0..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Medication primary text
ele-1: All FHIR elements must have a @value or children
...... subject SΣ 1..1 Reference(Patient | Group) Who or group medication request is for
ele-1: All FHIR elements must have a @value or children
...... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
....... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
ele-1: All FHIR elements must have a @value or children
....... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
ele-1: All FHIR elements must have a @value or children
...... authoredOn SΣ 1..1 dateTime Created date
ele-1: All FHIR elements must have a @value or children
...... requester SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/What requested the Request
ele-1: All FHIR elements must have a @value or children
...... note 0..* Annotation Information about the prescription
ele-1: All FHIR elements must have a @value or children
....... text SΣC 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
medication-request-note-length: Note - text size validation
...... dosageInstruction SC 0..* AUBaseDosage Dosage information in an Australian healthcare context
ele-1: All FHIR elements must have a @value or children
dosage-instruction-text-length: Dosage instruction - text size validation
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... text SΣ 0..1 string Free text dosage instructions e.g. SIG
ele-1: All FHIR elements must have a @value or children
....... patientInstruction SΣC 0..1 string Patient or consumer oriented instructions
ele-1: All FHIR elements must have a @value or children
patient-instruction-length: Dosage instruction - patient instruction size validation
....... timing SΣ 0..1 Timing Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension
ele-1: All FHIR elements must have a @value or children
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
ele-1: All FHIR elements must have a @value or children
....... doseAndRate SΣ 0..* Element Amount of medication administered
ele-1: All FHIR elements must have a @value or children
...... dispenseRequest S 0..1 BackboneElement Requested dispensing
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
ele-1: All FHIR elements must have a @value or children
....... quantity S 0..1 SimpleQuantity Amount of medication to supply per dispense
ele-1: All FHIR elements must have a @value or children
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
ele-1: All FHIR elements must have a @value or children
........ unit SΣ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
....... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
ele-1: All FHIR elements must have a @value or children
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
ele-1: All FHIR elements must have a @value or children
........ unit SΣ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
........ system SΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://unitsofmeasure.org
...... substitution 0..1 BackboneElement Brand substitution details
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... Slices for allowed[x] 1..1 Brand substitution flag
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.


ele-1: All FHIR elements must have a @value or children
........ allowedBoolean boolean
........ allowedCodeableConcept CodeableConcept
........ allowed[x]:allowedBoolean S 0..1 boolean Brand substitution flag
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
Bundle.entry:repeatprescription.resource.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:repeatprescriptionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:repeatprescriptionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dosage-instruction-text-lengtherrorBundle.entry:repeatprescription.resource.dosageInstructionDosage instruction - text size validation
: text.length() <= 200
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
medication-request-note-lengtherrorBundle.entry:repeatprescription.resource.note.textNote - text size validation
: value.exists().not() or value.length() <= 256
patient-instruction-lengtherrorBundle.entry:repeatprescription.resource.dosageInstruction.patientInstructionDosage instruction - patient instruction size validation
: value.exists().not() or value.length() <= 32

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... meta
.... tag 0..* Coding Tags applied to this resource
Binding: Writeback Action Type Value Set (required)
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: transaction
... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
.... entry:repeatprescription 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 AlexRepeatPrescription A request for a medication for a patient in an Australian healthcare context
...... meta
....... tag 0..0
..... request
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: PUT
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: MedicationRequest

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.meta.tagrequiredWritebackActionType (a valid code from Writeback Action Type CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/writeback-action-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: Writeback Action Type Value Set (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:repeatprescription ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 0..1 AlexRepeatPrescription A request for a medication for a patient in an Australian healthcare context
...... id SΣ 1..1 id The ID of the existing medication to be repeated.
...... meta Σ 0..1 Meta Metadata about the resource
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... versionId Σ 0..1 id Version specific identifier
....... lastUpdated Σ 0..1 instant When the resource version last changed
....... source Σ 0..1 uri Identifies where the resource comes from
....... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
....... security Σ 0..* Coding Security Labels applied to this resource
Binding: Definition of Confidentiality Value Set (required)
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
...... contained 0..* Resource Contained, inline Resources
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... longTerm 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term
....... scheme 0..1 Coding Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme
Binding: Medication Scheme (required)
....... unusualDose 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose
....... regulation24 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24
....... approvedNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number
....... authorityNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier 0..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
...... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Required Pattern: active
...... statusReason 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

...... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.


Required Pattern: order
...... category 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


...... priority Σ 0..1 code routine | urgent | asap | stat
Binding: Priority for Medication Request (required)
...... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
...... reported[x] Σ 0..1 Reported rather than primary record
....... reportedBoolean boolean
....... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
...... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

....... medication[x]:medicationReference SΣ 0..1 Reference(Medication) Prescribed Medication
....... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
......... coding:mimsPackage Σ 1..1 Coding MIMS Package
Binding: MIMS (preferred)
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.......... version Σ 0..1 string Version of the system - if relevant
.......... code SΣ 1..1 code Symbol in syntax defined by the system
.......... display SΣ 0..1 string Representation defined by the system
.......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text SΣ 0..1 string Medication primary text
...... subject SΣ 1..1 Reference(Patient | Group) Who or group medication request is for
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Reference to Patient resource
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... display Σ 0..1 string External Name of Patient
...... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
...... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
....... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
....... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
...... authoredOn SΣ 1..1 dateTime Created date
...... requester SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/What requested the Request
...... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
...... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

...... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
...... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Reason for Request (preferred)
...... reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
...... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
...... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
...... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
...... groupIdentifier Σ 0..1 Identifier Composite request this is part of
...... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

...... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
...... note 0..* Annotation Information about the prescription
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... author[x] Σ 0..1 Individual responsible for the annotation
........ authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
........ authorString string
....... time Σ 0..1 dateTime When the annotation was made
....... text SΣC 1..1 markdown The annotation - text content (as markdown)
medication-request-note-length: Note - text size validation
...... dosageInstruction SC 0..* AUBaseDosage Dosage information in an Australian healthcare context
dosage-instruction-text-length: Dosage instruction - text size validation
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... sequence Σ 0..1 integer The order of the dosage instructions
....... text SΣ 0..1 string Free text dosage instructions e.g. SIG
....... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
....... patientInstruction SΣC 0..1 string Patient or consumer oriented instructions
patient-instruction-length: Dosage instruction - patient instruction size validation
....... timing SΣ 0..1 Timing Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
....... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: Clinical Finding . (preferred)
........ asNeededBoolean boolean
........ asNeededCodeableConcept CodeableConcept
....... site Σ 0..1 CodeableConcept Body site to administer to
Binding: Body Site . (preferred)
....... route Σ 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
....... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
....... doseAndRate SΣ 0..* Element Amount of medication administered
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

........ dose[x] Σ 0..1 Amount of medication per dose
......... doseRange Range
......... doseQuantity Quantity(SimpleQuantity)
........ rate[x] Σ 0..1 Amount of medication per unit of time
......... rateRatio Ratio
......... rateRange Range
......... rateQuantity Quantity(SimpleQuantity)
....... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
....... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
....... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
...... dispenseRequest S 0..1 BackboneElement Requested dispensing
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
....... quantity S 0..1 SimpleQuantity Amount of medication to supply per dispense
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
........ unit SΣ 0..1 string Unit representation
....... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
........ unit SΣ 0..1 string Unit representation
........ system SΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
........ code Σ 0..1 code Coded form of the unit
Binding: Duration (required)
...... substitution 0..1 BackboneElement Brand substitution details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... Slices for allowed[x] 1..1 Brand substitution flag
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

........ allowedBoolean boolean
........ allowedCodeableConcept CodeableConcept
........ allowed[x]:allowedBoolean S 0..1 boolean Brand substitution flag
....... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: Medicine Substitution Reason (preferred)
...... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
...... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.


Required Pattern: PUT
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: MedicationRequest
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.meta.tagrequiredWritebackActionType (a valid code from Writeback Action Type CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/writeback-action-type
from this IG
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.meta.securityrequiredConfidentialityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality
from this IG
Bundle.entry:repeatprescription.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:repeatprescription.resource.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
from the FHIR Standard
Bundle.entry:repeatprescription.resource.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
Bundle.entry:repeatprescription.resource.priorityrequiredMedicationRequestPriorityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/request-priority
from this IG
Bundle.entry:repeatprescription.resource.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
Bundle.entry:repeatprescription.resource.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Bundle.entry:repeatprescription.resource.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Bundle.entry:repeatprescription.resource.reasonCodepreferredReasonForRequest
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
from this IG
Bundle.entry:repeatprescription.resource.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
Bundle.entry:repeatprescription.resource.dosageInstruction.asNeeded[x]preferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
Bundle.entry:repeatprescription.resource.dosageInstruction.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Bundle.entry:repeatprescription.resource.dosageInstruction.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG
Bundle.entry:repeatprescription.resource.dosageInstruction.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dispenseRequest.expectedSupplyDuration.coderequiredDuration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/duration
from this IG
Bundle.entry:repeatprescription.resource.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
Bundle.entry:repeatprescription.resource.substitution.reasonpreferredMedicineSubstitutionReason
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1
from this IG
Bundle.entry:repeatprescription.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.request.methodrequiredPattern: PUT
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:repeatprescriptionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:repeatprescriptionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dosage-instruction-text-lengtherrorBundle.entry:repeatprescription.resource.dosageInstructionDosage instruction - text size validation
: text.length() <= 200
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
medication-request-note-lengtherrorBundle.entry:repeatprescription.resource.note.textNote - text size validation
: value.exists().not() or value.length() <= 256
patient-instruction-lengtherrorBundle.entry:repeatprescription.resource.dosageInstruction.patientInstructionDosage instruction - patient instruction size validation
: value.exists().not() or value.length() <= 32

This structure is derived from Bundle

Summary

Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


ele-1: All FHIR elements must have a @value or children
Required Pattern: transaction
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entry:repeatprescription ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 AlexRepeatPrescription A request for a medication for a patient in an Australian healthcare context
...... id SΣ 1..1 id The ID of the existing medication to be repeated.
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... longTerm 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... scheme 0..1 Coding Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme
Binding: Medication Scheme (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... unusualDose 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... regulation24 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... approvedNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... authorityNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


ele-1: All FHIR elements must have a @value or children
Required Pattern: active
...... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.


ele-1: All FHIR elements must have a @value or children
Required Pattern: order
...... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
ele-1: All FHIR elements must have a @value or children
...... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.


ele-1: All FHIR elements must have a @value or children
....... medication[x]:medicationReference SΣ 0..1 Reference(Medication) Prescribed Medication
ele-1: All FHIR elements must have a @value or children
....... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.


ele-1: All FHIR elements must have a @value or children
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
......... coding:mimsPackage Σ 1..1 Coding MIMS Package
Binding: MIMS (preferred)
ele-1: All FHIR elements must have a @value or children
.......... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://www.mims.com.au/codes
.......... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
.......... display SΣ 0..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
........ text SΣ 0..1 string Medication primary text
ele-1: All FHIR elements must have a @value or children
...... subject SΣ 1..1 Reference(Patient | Group) Who or group medication request is for
ele-1: All FHIR elements must have a @value or children
...... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
....... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
ele-1: All FHIR elements must have a @value or children
....... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
ele-1: All FHIR elements must have a @value or children
...... authoredOn SΣ 1..1 dateTime Created date
ele-1: All FHIR elements must have a @value or children
...... requester SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/What requested the Request
ele-1: All FHIR elements must have a @value or children
...... note 0..* Annotation Information about the prescription
ele-1: All FHIR elements must have a @value or children
....... text SΣC 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
medication-request-note-length: Note - text size validation
...... dosageInstruction SC 0..* AUBaseDosage Dosage information in an Australian healthcare context
ele-1: All FHIR elements must have a @value or children
dosage-instruction-text-length: Dosage instruction - text size validation
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... text SΣ 0..1 string Free text dosage instructions e.g. SIG
ele-1: All FHIR elements must have a @value or children
....... patientInstruction SΣC 0..1 string Patient or consumer oriented instructions
ele-1: All FHIR elements must have a @value or children
patient-instruction-length: Dosage instruction - patient instruction size validation
....... timing SΣ 0..1 Timing Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension
ele-1: All FHIR elements must have a @value or children
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
ele-1: All FHIR elements must have a @value or children
....... doseAndRate SΣ 0..* Element Amount of medication administered
ele-1: All FHIR elements must have a @value or children
...... dispenseRequest S 0..1 BackboneElement Requested dispensing
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
ele-1: All FHIR elements must have a @value or children
....... quantity S 0..1 SimpleQuantity Amount of medication to supply per dispense
ele-1: All FHIR elements must have a @value or children
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
ele-1: All FHIR elements must have a @value or children
........ unit SΣ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
....... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
ele-1: All FHIR elements must have a @value or children
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
ele-1: All FHIR elements must have a @value or children
........ unit SΣ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
........ system SΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://unitsofmeasure.org
...... substitution 0..1 BackboneElement Brand substitution details
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... Slices for allowed[x] 1..1 Brand substitution flag
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.


ele-1: All FHIR elements must have a @value or children
........ allowedBoolean boolean
........ allowedCodeableConcept CodeableConcept
........ allowed[x]:allowedBoolean S 0..1 boolean Brand substitution flag
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
Bundle.entry:repeatprescription.resource.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:repeatprescriptionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:repeatprescriptionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dosage-instruction-text-lengtherrorBundle.entry:repeatprescription.resource.dosageInstructionDosage instruction - text size validation
: text.length() <= 200
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
medication-request-note-lengtherrorBundle.entry:repeatprescription.resource.note.textNote - text size validation
: value.exists().not() or value.length() <= 256
patient-instruction-lengtherrorBundle.entry:repeatprescription.resource.dosageInstruction.patientInstructionDosage instruction - patient instruction size validation
: value.exists().not() or value.length() <= 32

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... meta
.... tag 0..* Coding Tags applied to this resource
Binding: Writeback Action Type Value Set (required)
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: transaction
... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
.... entry:repeatprescription 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 AlexRepeatPrescription A request for a medication for a patient in an Australian healthcare context
...... meta
....... tag 0..0
..... request
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: PUT
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: MedicationRequest

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.meta.tagrequiredWritebackActionType (a valid code from Writeback Action Type CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/writeback-action-type
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: Writeback Action Type Value Set (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:repeatprescription ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 0..1 AlexRepeatPrescription A request for a medication for a patient in an Australian healthcare context
...... id SΣ 1..1 id The ID of the existing medication to be repeated.
...... meta Σ 0..1 Meta Metadata about the resource
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... versionId Σ 0..1 id Version specific identifier
....... lastUpdated Σ 0..1 instant When the resource version last changed
....... source Σ 0..1 uri Identifies where the resource comes from
....... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
....... security Σ 0..* Coding Security Labels applied to this resource
Binding: Definition of Confidentiality Value Set (required)
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
...... contained 0..* Resource Contained, inline Resources
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... longTerm 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-long-term
....... scheme 0..1 Coding Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-scheme
Binding: Medication Scheme (required)
....... unusualDose 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-unusual-dose
....... regulation24 0..1 boolean Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-regulation-24
....... approvedNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-approved-number
....... authorityNumber 0..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/medication-authority-number
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier 0..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
...... status ?!SΣ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Required Pattern: active
...... statusReason 0..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

...... intent ?!SΣ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.


Required Pattern: order
...... category 0..* CodeableConcept Type of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


...... priority Σ 0..1 code routine | urgent | asap | stat
Binding: Priority for Medication Request (required)
...... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
...... reported[x] Σ 0..1 Reported rather than primary record
....... reportedBoolean boolean
....... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
...... Slices for medication[x] Σ 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

....... medication[x]:medicationReference SΣ 0..1 Reference(Medication) Prescribed Medication
....... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept Coded Prescribed Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
......... coding:mimsPackage Σ 1..1 Coding MIMS Package
Binding: MIMS (preferred)
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.......... version Σ 0..1 string Version of the system - if relevant
.......... code SΣ 1..1 code Symbol in syntax defined by the system
.......... display SΣ 0..1 string Representation defined by the system
.......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text SΣ 0..1 string Medication primary text
...... subject SΣ 1..1 Reference(Patient | Group) Who or group medication request is for
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Reference to Patient resource
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... display Σ 0..1 string External Name of Patient
...... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
...... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
Slice: Unordered, Open by profile:resolve()
....... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
....... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
...... authoredOn SΣ 1..1 dateTime Created date
...... requester SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/What requested the Request
...... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
...... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

...... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
...... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Binding: Reason for Request (preferred)
...... reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
...... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
...... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
...... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
...... groupIdentifier Σ 0..1 Identifier Composite request this is part of
...... courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

...... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
...... note 0..* Annotation Information about the prescription
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... author[x] Σ 0..1 Individual responsible for the annotation
........ authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
........ authorString string
....... time Σ 0..1 dateTime When the annotation was made
....... text SΣC 1..1 markdown The annotation - text content (as markdown)
medication-request-note-length: Note - text size validation
...... dosageInstruction SC 0..* AUBaseDosage Dosage information in an Australian healthcare context
dosage-instruction-text-length: Dosage instruction - text size validation
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... sequence Σ 0..1 integer The order of the dosage instructions
....... text SΣ 0..1 string Free text dosage instructions e.g. SIG
....... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
....... patientInstruction SΣC 0..1 string Patient or consumer oriented instructions
patient-instruction-length: Dosage instruction - patient instruction size validation
....... timing SΣ 0..1 Timing Since daily frequency is user defineable in PMS, it may contain other code defined with Medtech extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
........ code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
....... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: Clinical Finding . (preferred)
........ asNeededBoolean boolean
........ asNeededCodeableConcept CodeableConcept
....... site Σ 0..1 CodeableConcept Body site to administer to
Binding: Body Site . (preferred)
....... route Σ 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
....... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
....... doseAndRate SΣ 0..* Element Amount of medication administered
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

........ dose[x] Σ 0..1 Amount of medication per dose
......... doseRange Range
......... doseQuantity Quantity(SimpleQuantity)
........ rate[x] Σ 0..1 Amount of medication per unit of time
......... rateRatio Ratio
......... rateRange Range
......... rateQuantity Quantity(SimpleQuantity)
....... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
....... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
....... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
...... dispenseRequest S 0..1 BackboneElement Requested dispensing
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... numberOfRepeatsAllowed S 0..1 unsignedInt Maximum repeats authorised
....... quantity S 0..1 SimpleQuantity Amount of medication to supply per dispense
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
........ unit SΣ 0..1 string Unit representation
....... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ 0..1 decimal Numerical value (with implicit precision)
........ unit SΣ 0..1 string Unit representation
........ system SΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
........ code Σ 0..1 code Coded form of the unit
Binding: Duration (required)
...... substitution 0..1 BackboneElement Brand substitution details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... Slices for allowed[x] 1..1 Brand substitution flag
Slice: Unordered, Open by type:$this
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

........ allowedBoolean boolean
........ allowedCodeableConcept CodeableConcept
........ allowed[x]:allowedBoolean S 0..1 boolean Brand substitution flag
....... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: Medicine Substitution Reason (preferred)
...... priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
...... detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.


Required Pattern: PUT
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: MedicationRequest
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.meta.tagrequiredWritebackActionType (a valid code from Writeback Action Type CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/writeback-action-type
from this IG
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.meta.securityrequiredConfidentialityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality
from this IG
Bundle.entry:repeatprescription.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:repeatprescription.resource.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
from the FHIR Standard
Bundle.entry:repeatprescription.resource.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
Bundle.entry:repeatprescription.resource.priorityrequiredMedicationRequestPriorityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/request-priority
from this IG
Bundle.entry:repeatprescription.resource.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
Bundle.entry:repeatprescription.resource.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Bundle.entry:repeatprescription.resource.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Bundle.entry:repeatprescription.resource.reasonCodepreferredReasonForRequest
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
from this IG
Bundle.entry:repeatprescription.resource.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
Bundle.entry:repeatprescription.resource.dosageInstruction.asNeeded[x]preferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
Bundle.entry:repeatprescription.resource.dosageInstruction.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Bundle.entry:repeatprescription.resource.dosageInstruction.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG
Bundle.entry:repeatprescription.resource.dosageInstruction.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard
Bundle.entry:repeatprescription.resource.dispenseRequest.expectedSupplyDuration.coderequiredDuration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/duration
from this IG
Bundle.entry:repeatprescription.resource.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
Bundle.entry:repeatprescription.resource.substitution.reasonpreferredMedicineSubstitutionReason
https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1
from this IG
Bundle.entry:repeatprescription.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:repeatprescription.request.methodrequiredPattern: PUT
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:repeatprescriptionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:repeatprescriptionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dosage-instruction-text-lengtherrorBundle.entry:repeatprescription.resource.dosageInstructionDosage instruction - text size validation
: text.length() <= 200
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
medication-request-note-lengtherrorBundle.entry:repeatprescription.resource.note.textNote - text size validation
: value.exists().not() or value.length() <= 256
patient-instruction-lengtherrorBundle.entry:repeatprescription.resource.dosageInstruction.patientInstructionDosage instruction - patient instruction size validation
: value.exists().not() or value.length() <= 32

This structure is derived from Bundle

Summary

Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry (Closed)

 

Other representations of profile: CSV, Excel, Schematron