| Australian Digital Health Agency FHIR Implementation Guide 1.0.0

Australian Digital Health Agency FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available versions.

#### StructureDefinition: ADHA PBS Claim Item - Detailed Descriptions

Definitions for the dh-medicationrequest-pbs-claim-1 Profile.

1. MedicationRequest
Definition | A PBS claim item includes information about pharmaceutical items prescribed and dispensed to an individual that were partially or fully funded under the PBS or Repatriation Pharmaceutical Benefits Scheme (RPBS).
Control | 0..*
Alternate Names | PrescriptionOrder
2. MedicationRequest.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. MedicationRequest.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. MedicationRequest.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. MedicationRequest.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. MedicationRequest.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Alternate Names | narrativehtmlxhtmldisplay
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. MedicationRequest.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resourcesanonymous resourcescontained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. MedicationRequest.extension
Definition | An Extension
Control | 0..*
Type | Extension
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MedicationRequest.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. MedicationRequest.extension:subsidisedConcurrentSupply
SliceName | subsidisedConcurrentSupply
Definition | The grounds which authorise a PBS or RPBS subsidy for the concurrent supply of a medication item specified in a prescription and all of its repeats.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(GroundsForConcurrentSupplyOfMedication) (Extension Type: Coding)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. MedicationRequest.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. MedicationRequest.identifier
Definition | Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..* This element is affected by the following invariants: ele-1
Type | Identifier(Identifier AUETPPrescriptionIdentifier AULocalPrescriptionIdentifier)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Comments | This is a business identifier, not a resource identifier.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. MedicationRequest.status
Definition | A code specifying the current state of the order. Generally, this will be active or completed state.
Control | 1..1
Binding | The codes SHALL be taken from medicationrequest Status A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription
Type | code
Is Modifier | true
Must Support | true
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Fixed Value | unknown
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. MedicationRequest.statusReason
Definition | Captures the reason for the current state of the MedicationRequest.
Control | 0..1
Binding | For example codes, see medicationRequest Status Reason Codes Identifies the reasons for a given status
Type | CodeableConcept
Comments | This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. MedicationRequest.intent
Definition | Whether the request is a proposal, plan, or an original order.
Control | 1..1
Binding | The codes SHALL be taken from medicationRequest Intent The kind of medication order
Type | code
Is Modifier | true
Must Support | true
Comments | It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only. An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
Fixed Value | order
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. MedicationRequest.category
Definition | Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
Control | 0..*
Binding | For example codes, see medicationRequest Category Codes 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
Type | CodeableConcept
Comments | The category can be used to include where the medication is expected to be consumed or other types of requests.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. MedicationRequest.priority
Definition | Indicates how quickly the Medication Request should be addressed with respect to other requests.
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority Identifies the level of importance to be assigned to actioning the request
Type | code
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. MedicationRequest.doNotPerform
Definition | If true indicates that the provider is asking for the medication request not to occur.
Control | 0..1
Type | boolean
Is Modifier | true
Comments | If do not perform is not specified, the request is a positive request e.g. "do perform".
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. MedicationRequest.reported[x]
Definition | Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
Control | 0..1
Type | Choice of: boolean, Reference(Patient Practitioner PractitionerRole RelatedPerson Organization))
[x] Note | See Choice of Data Types for further information about how to use [x]
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. MedicationRequest.medication[x]
Definition | Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
Control | 1..1
Binding | For example codes, see SNOMEDCTMedicationCodes A coded concept identifying substance or product that can be ordered
Type | Reference(Medication))
[x] Note | See Choice of Data Types for further information about how to use [x]
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on MedicationRequest.medication[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators: type @ $this
20. MedicationRequest.medication[x]:medicationReference
SliceName | medicationReference
Definition | Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
Control | 1..1 This element is affected by the following invariants: inv-dh-pbs-03
Type | Reference(ADHAMedicationCore))
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-pbs-03: At least reference shall be present (: reference.exists())
21. MedicationRequest.medication[x]:medicationCodeableConcept
SliceName | medicationCodeableConcept
Definition | Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
Control | 0..1
Binding | For example codes, see SNOMEDCTMedicationCodes A coded concept identifying substance or product that can be ordered
Type | CodeableConcept
[x] Note | See Choice of Data Types for further information about how to use [x]
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. MedicationRequest.medication[x]:medicationCodeableConcept.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
23. MedicationRequest.medication[x]:medicationCodeableConcept.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MedicationRequest.medication[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
24. MedicationRequest.medication[x]:medicationCodeableConcept.coding
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Type | Coding
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on MedicationRequest.medication[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ system
25. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs
SliceName | pbs
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Binding | The codes SHOULD be taken from PBS Item Codes
Type | Coding
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | PBS code from http://pbs.gov.au/code/item. Use of PBS as a code to refer to a type of medication, this excludes implication of context based on the PBS code. Where context is to be implied or stated PBS code needs to be associated with recording a prescription (MedicationRequest) or dispense record (MedicationDispense).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
27. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MedicationRequest.medication[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
28. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 1..1
Type | uri
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Fixed Value | http://pbs.gov.au/code/item
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Control | 0..1
Type | string
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Control | 0..1
Type | boolean
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin
SliceName | gtin
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Binding | The codes SHOULD be taken from GTIN
Type | Coding
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | GTIN value from http://www.gs1.org/gtin.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
35. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MedicationRequest.medication[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
36. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 1..1
Type | uri
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Fixed Value | http://www.gs1.org/gtin
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Control | 0..1
Type | string
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Control | 0..1
Type | boolean
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt
SliceName | amt
Definition | A reference to a code defined by a terminology system.
Control | 0..*
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Type | Coding
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
43. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.extension
Definition | An Extension
Control | 0..*
Type | Extension
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MedicationRequest.medication[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
44. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.extension:medicationClass
SliceName | medicationClass
Definition | The type of information covered by the medication coding, e.g. branded product with no strength or form.
Control | 0..1
Type | Extension(MedicationType) (Extension Type: Coding)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
45. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 1..1
Type | uri
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Fixed Value | http://snomed.info/sct
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Control | 0..1
Type | string
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Control | 0..1
Type | boolean
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage
SliceName | mimsPackage
Definition | A reference to a code defined by a terminology system.
Control | 0..1
Binding | The codes SHOULD be taken from MIMS
Type | Coding
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
52. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MedicationRequest.medication[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
53. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Control | 1..1
Type | uri
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Fixed Value | http://www.mims.com.au/codes
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Control | 0..1
Type | code
Requirements | Need to refer to a particular code in the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Control | 0..1
Type | string
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Control | 0..1
Type | boolean
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. MedicationRequest.medication[x]:medicationCodeableConcept.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. This may be a brand or generic name as suitable for the intent of the entry.
Control | 0..1
Type | string
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments | Very often the text is the same as a displayName of one of the codings.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. MedicationRequest.subject
Definition | A link to a resource representing the person or set of individuals to whom the medication will be given.
Control | 1..1 This element is affected by the following invariants: inv-dh-medreq-01
Type | Reference(ADHAPatientCore))
Must Support | true
Comments | The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-medreq-01: At least reference or a valid identifier shall be present (: reference.exists() or identifier.where(system.count() + value.count() >1).exists())
60. MedicationRequest.encounter
Definition | The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
Control | 0..1
Type | Reference(Encounter))
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter." If there is a need to link to episodes of care they will be handled with an extension.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. MedicationRequest.supportingInformation
Definition | Include additional information (for example, patient height and weight) that supports the ordering of the medication.
Control | 0..*
Type | Reference(Resource))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on MedicationRequest.supportingInformation. The slices are unordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
62. MedicationRequest.supportingInformation:bodyHeight
SliceName | bodyHeight
Definition | Include additional information (for example, patient height and weight) that supports the ordering of the medication.
Control | 0..1
Type | Reference(observation-bodyheight))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. MedicationRequest.supportingInformation:bodyWeight
SliceName | bodyWeight
Definition | Include additional information (for example, patient height and weight) that supports the ordering of the medication.
Control | 0..1
Type | Reference(observation-bodyweight))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. MedicationRequest.authoredOn
Definition | The date (and perhaps time) when the prescription was initially written or authored on.
Control | 1..1
Type | dateTime
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. MedicationRequest.requester
Definition | The individual, organization, or device that initiated the request and has responsibility for its activation.
Control | 0..1
Type | Reference(Practitioner PractitionerRole Organization Patient RelatedPerson Device))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. MedicationRequest.performer
Definition | The specified desired performer of the medication treatment (e.g. the performer of the medication administration).
Control | 0..1
Type | Reference(Practitioner PractitionerRole Organization Patient Device RelatedPerson CareTeam))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. MedicationRequest.performerType
Definition | Indicates the type of performer of the administration of the medication.
Control | 0..1
Binding | For example codes, see ProcedurePerformerRoleCodes Identifies the type of individual that is desired to administer the medication
Type | CodeableConcept
Comments | If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. MedicationRequest.recorder
Definition | The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
Control | 0..1
Type | Reference(Practitioner PractitionerRole))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. MedicationRequest.reasonCode
Definition | The reason or the indication for ordering or not ordering the medication.
Control | 0..*
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
Type | CodeableConcept
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. MedicationRequest.reasonReference
Definition | Condition or observation that supports why the medication was ordered.
Control | 0..*
Type | Reference(Condition Observation))
Comments | This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. MedicationRequest.instantiatesCanonical
Definition | The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
Control | 0..*
Type | canonical
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. MedicationRequest.instantiatesUri
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.
Control | 0..*
Type | uri
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. MedicationRequest.basedOn
Definition | A plan or request that is fulfilled in whole or in part by this medication request.
Control | 0..*
Type | Reference(CarePlan MedicationRequest ServiceRequest ImmunizationRecommendation))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. MedicationRequest.groupIdentifier
Definition | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
Control | 0..1
Type | Identifier
Requirements | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. MedicationRequest.courseOfTherapyType
Definition | The description of the overall patte3rn of the administration of the medication to the patient.
Control | 0..1
Binding | For example codes, see medicationRequest Course of Therapy Codes Identifies the overall pattern of medication administratio
Type | CodeableConcept
Comments | This attribute should not be confused with the protocol of the medication.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. MedicationRequest.insurance
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
Control | 0..*
Type | Reference(Coverage ClaimResponse))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. MedicationRequest.note
Definition | Extra information about the prescription that could not be conveyed by the other attributes.
Control | 0..*
Type | Annotation
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. MedicationRequest.dosageInstruction
Definition | Indicates how the medication is/was taken or should be taken by the patient.
Control | 0..*
Type | Dosage(AUBaseDosage)
Comments | There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. MedicationRequest.dispenseRequest
Definition | Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
Control | 1..1
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. MedicationRequest.dispenseRequest.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
81. MedicationRequest.dispenseRequest.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
82. MedicationRequest.dispenseRequest.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
83. MedicationRequest.dispenseRequest.initialFill
Definition | Indicates the quantity or duration for the first dispense of the medication.
Control | 0..1
Type | BackboneElement
Comments | If populating this element, either the quantity or the duration must be included.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. MedicationRequest.dispenseRequest.initialFill.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
85. MedicationRequest.dispenseRequest.initialFill.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
86. MedicationRequest.dispenseRequest.initialFill.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
87. MedicationRequest.dispenseRequest.initialFill.quantity
Definition | The amount or quantity to provide as part of the first dispense.
Control | 0..1
Type | Quantity(SimpleQuantity)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. MedicationRequest.dispenseRequest.initialFill.duration
Definition | The length of time that the first dispense is expected to last.
Control | 0..1
Type | Duration
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
89. MedicationRequest.dispenseRequest.dispenseInterval
Definition | The minimum period of time that must occur between dispenses of the medication.
Control | 0..1
Type | Duration
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. MedicationRequest.dispenseRequest.validityPeriod
Definition | This indicates the validity period of a prescription (stale dating the Prescription).
Control | 0..1
Type | Period
Requirements | Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.
Comments | It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
91. MedicationRequest.dispenseRequest.numberOfRepeatsAllowed
Definition | An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.
Control | 0..1
Type | unsignedInt
Must Support | true
Comments | If displaying "number of authorized fills", add 1 to this number.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
92. MedicationRequest.dispenseRequest.quantity
Definition | The amount that is to be dispensed for one fill.
Control | 1..1
Type | Quantity(SimpleQuantity)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. MedicationRequest.dispenseRequest.expectedSupplyDuration
Definition | Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
Control | 0..1
Type | Duration
Comments | In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. MedicationRequest.dispenseRequest.performer
Definition | Indicates the intended dispensing Organization specified by the prescriber.
Control | 0..1
Type | Reference(Organization))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. MedicationRequest.substitution
Definition | Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
Control | 0..1
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
96. MedicationRequest.substitution.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
97. MedicationRequest.substitution.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
98. MedicationRequest.substitution.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
99. MedicationRequest.substitution.allowed[x]
Definition | True if the prescriber allows a different drug to be dispensed from what was prescribed.
Control | 1..1
Binding | For example codes, see ActSubstanceAdminSubstitutionCode Identifies the type of substitution allowed
Type | Choice of: boolean, CodeableConcept
[x] Note | See Choice of Data Types for further information about how to use [x]
Comments | This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
100. MedicationRequest.substitution.reason
Definition | Indicates the reason for the substitution, or why substitution must or must not be performed.
Control | 0..1
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
101. MedicationRequest.priorPrescription
Definition | A link to a resource representing an earlier order related order or prescription.
Control | 0..1
Type | Reference(MedicationRequest))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
102. MedicationRequest.detectedIssue
Definition | Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
Control | 0..*
Type | Reference(DetectedIssue))
Alternate Names | ContraindicationDrug Utilization Review (DUR)Alert
Comments | This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
103. MedicationRequest.eventHistory
Definition | Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
Control | 0..*
Type | Reference(Provenance))
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))