This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-au-medicationrequest Profile.
1. MedicationRequest | |
Definition | Prescription of medication |
Control | 0..* |
Alternate Names | Prescription, Order |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
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 may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
5. MedicationRequest.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable Max Binding: All Languages |
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). |
6. MedicationRequest.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
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 in formation is added later. |
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 resources, anonymous resources, contained 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. |
8. MedicationRequest.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
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:
|
9. MedicationRequest.extension:groundsForConcurrentSupply | |
SliceName | groundsForConcurrentSupply |
Definition | Coded Grounds for Concurrent Supply of Medication |
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() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. MedicationRequest.extension:minimumIntervalBetweenRepeats | |
SliceName | minimumIntervalBetweenRepeats |
Definition | The supplied duration that must pass between dispensing of repeats of the associated medication request. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(MinimumIntervalBetweenRepeats) (Extension Type: Duration) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
11. MedicationRequest.extension:brandName | |
SliceName | brandName |
Definition | The brand medication text name for an associated medication, this may be supplied if a coded brand name is not available for medicationCodeableConcept but the brand name is needed. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(MedicationBrandName) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
12. MedicationRequest.extension:genericName | |
SliceName | genericName |
Definition | The generic medication text name for an associated medication, this may not be the same as the medicationCodeableConcept medication (prescribed, dispensed or stated) but may be used to provide an additional or equivalent drug name that is a generic medication concept. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(MedicationGenericName) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
13. 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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user 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. |
14. MedicationRequest.identifier | |
Definition | This records 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. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Slicing | This element introduces a set of slices on MedicationRequest.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
15. MedicationRequest.identifier:etpVendorIdentifier | |
SliceName | etpVendorIdentifier |
Definition | Identifier assigned by ETP vendor e.g. ERx, Medisecure etc. This is the assgigned numeric value typically represented as a barcode on a prescription instance. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
16. MedicationRequest.identifier:etpVendorIdentifier.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 |
17. MedicationRequest.identifier:etpVendorIdentifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. MedicationRequest.identifier:etpVendorIdentifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
19. MedicationRequest.identifier:etpVendorIdentifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 1..1 |
Binding | Local Identifier Type The codes SHALL be taken from v2 Identifier Type - AU Extended |
Type | CodeableConcept |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
20. MedicationRequest.identifier:etpVendorIdentifier.type.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 |
21. MedicationRequest.identifier:etpVendorIdentifier.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
22. MedicationRequest.identifier:etpVendorIdentifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..1 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
23. MedicationRequest.identifier:etpVendorIdentifier.type.coding.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 |
24. MedicationRequest.identifier:etpVendorIdentifier.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
25. MedicationRequest.identifier:etpVendorIdentifier.type.coding.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 de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://hl7.org.au/fhir/v2/0203 |
26. MedicationRequest.identifier:etpVendorIdentifier.type.coding.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. |
27. MedicationRequest.identifier:etpVendorIdentifier.type.coding.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 | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | ETP |
28. MedicationRequest.identifier:etpVendorIdentifier.type.coding.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. |
29. MedicationRequest.identifier:etpVendorIdentifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. 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. |
30. MedicationRequest.identifier:etpVendorIdentifier.type.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. |
Control | 1..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. |
Fixed Value | ETP Identifier |
31. MedicationRequest.identifier:etpVendorIdentifier.system | |
Definition | URL assigned by the ETP (electronic transfer of prescription) vendor allocating the identifier. |
Control | 1..1 |
Type | uri |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | General:http://www.acme.com/identifiers/patient |
32. MedicationRequest.identifier:etpVendorIdentifier.value | |
Definition | ETP Vendor allocated identifier for the request this dispense record is fulfilling. |
Control | 1..1 |
Type | string |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Example | General:123456 |
33. MedicationRequest.identifier:etpVendorIdentifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
34. MedicationRequest.identifier:etpVendorIdentifier.assigner | |
Definition | ETP Vendor assigning this identifier |
Control | 1..1 |
Type | Reference(Organization) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
35. MedicationRequest.identifier:etpVendorIdentifier.assigner.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 |
36. MedicationRequest.identifier:etpVendorIdentifier.assigner.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
37. MedicationRequest.identifier:etpVendorIdentifier.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
38. MedicationRequest.identifier:etpVendorIdentifier.assigner.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
39. MedicationRequest.identifier:etpVendorIdentifier.assigner.display | |
Definition | Name of the ETP vendor assigning this identifier. |
Control | 1..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
40. MedicationRequest.identifier:localScriptNumber | |
SliceName | localScriptNumber |
Definition | Identifier assigined by the prescribing system allows linking of a prescription record to local system identifier. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
41. MedicationRequest.identifier:localScriptNumber.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 |
42. MedicationRequest.identifier:localScriptNumber.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
43. MedicationRequest.identifier:localScriptNumber.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
44. MedicationRequest.identifier:localScriptNumber.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 1..1 |
Binding | Local Identifier Type The codes SHALL be taken from v2 Identifier Type - AU Extended |
Type | CodeableConcept |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
45. MedicationRequest.identifier:localScriptNumber.type.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 |
46. MedicationRequest.identifier:localScriptNumber.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
47. MedicationRequest.identifier:localScriptNumber.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..1 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
48. MedicationRequest.identifier:localScriptNumber.type.coding.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 |
49. MedicationRequest.identifier:localScriptNumber.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
50. MedicationRequest.identifier:localScriptNumber.type.coding.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 de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://hl7.org.au/fhir/v2/0203 |
51. MedicationRequest.identifier:localScriptNumber.type.coding.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. |
52. MedicationRequest.identifier:localScriptNumber.type.coding.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 | 1..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | LPN |
53. MedicationRequest.identifier:localScriptNumber.type.coding.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. |
54. MedicationRequest.identifier:localScriptNumber.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. 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. |
55. MedicationRequest.identifier:localScriptNumber.type.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. |
Control | 1..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. |
Fixed Value | Local Prescription Number |
56. MedicationRequest.identifier:localScriptNumber.system | |
Definition | URL namespace assigned by the local prescription system. |
Control | 1..1 |
Type | uri |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | General:http://www.acme.com/identifiers/patient |
57. MedicationRequest.identifier:localScriptNumber.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | string |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Example | General:123456 |
58. MedicationRequest.identifier:localScriptNumber.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
59. MedicationRequest.identifier:localScriptNumber.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 1..1 |
Type | Reference(Organization) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
60. MedicationRequest.identifier:localScriptNumber.assigner.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 |
61. MedicationRequest.identifier:localScriptNumber.assigner.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
Slicing | This element introduces a set of slices on MedicationRequest.identifier.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
62. MedicationRequest.identifier:localScriptNumber.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
63. MedicationRequest.identifier:localScriptNumber.assigner.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
64. MedicationRequest.identifier:localScriptNumber.assigner.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 1..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
65. MedicationRequest.definition | |
Definition | Protocol or definition followed by this request. |
Control | 0..* |
Type | Reference(ActivityDefinition | PlanDefinition) |
66. 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 | ProcedureRequest | ReferralRequest) |
67. 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. |
68. MedicationRequest.status | |
Definition | A code specifying the current state of the order. Generally this will be active or completed state. |
Control | 0..1 |
Binding | A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription The codes SHALL be taken from MedicationRequestStatus |
Type | code |
Is Modifier | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
69. MedicationRequest.intent | |
Definition | Whether the request is a proposal, plan, or an original order. |
Control | 1..1 |
Binding | The kind of medication order The codes SHALL be taken from MedicationRequestIntent |
Type | code |
Is Modifier | 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. |
70. MedicationRequest.category | |
Definition | Indicates the type of medication order and where the medication is expected to be consumed or administered. |
Control | 0..1 |
Binding | A coded concept identifying where the medication ordered is expected to be consumed or administered The codes SHOULD be taken from MedicationRequestCategory |
Type | CodeableConcept |
71. MedicationRequest.priority | |
Definition | Indicates how quickly the Medication Request should be addressed with respect to other requests. |
Control | 0..1 |
Binding | Identifies the level of importance to be assigned to actioning the request The codes SHALL be taken from MedicationRequestPriority |
Type | code |
72. 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 | A coded concept identifying substance or product that can be ordered. For example codes, see SNOMED CT Medication Codes |
Type | Choice of: CodeableConcept, 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. . |
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:
|
73. 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 | A coded concept identifying substance or product that can be ordered. For example codes, see SNOMED CT Medication Codes |
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. . |
74. 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 |
75. MedicationRequest.medication[x]:medicationCodeableConcept.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
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:
|
76. MedicationRequest.medication[x]:medicationCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
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:
|
77. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs | |
SliceName | pbs |
Definition | 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) |
Control | 0..* |
Binding | The codes SHOULD be taken from PBS Medicines Item Codes |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
78. 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 |
79. 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. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
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:
|
80. 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 de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://pbs.gov.au/code/item |
81. 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. |
82. 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. |
83. 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. |
84. MedicationRequest.medication[x]:medicationCodeableConcept.coding:pbs.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. 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. |
85. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin | |
SliceName | gtin |
Definition | GTIN value from http://www.gs1.org/gtin. |
Control | 0..* |
Binding | The codes SHOULD be taken from GTIN for Medicines |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
86. 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 |
87. 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. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
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:
|
88. 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 de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://www.gs1.org/gtin |
89. 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. |
90. 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. |
91. 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. |
92. MedicationRequest.medication[x]:medicationCodeableConcept.coding:gtin.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. 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. |
93. 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 translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
94. 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 |
95. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
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:
|
96. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.extension:medicationClass | |
SliceName | medicationClass |
Definition | General category of coding to allow usage of codes to be distinguished from the same CodeSystem |
Control | 0..1 |
Type | Extension(MedicationType) (Extension Type: Coding) |
97. 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 de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
98. 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. |
99. 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. |
100. 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. |
101. MedicationRequest.medication[x]:medicationCodeableConcept.coding:amt.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. 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. |
102. 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 Terminology |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
103. 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 |
104. 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. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
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:
|
105. 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 de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://www.mims.com.au/codes |
106. 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. |
107. 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. |
108. 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. |
109. MedicationRequest.medication[x]:medicationCodeableConcept.coding:mimsPackage.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. 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. |
110. 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. |
111. 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 | 0..1 |
Type | Reference(AUBaseMedication) |
[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. . |
112. 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 |
Type | Reference(Patient | Group) |
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. |
113. MedicationRequest.context | |
Definition | A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Comments | SubstanceAdministration->component->EncounterEvent. |
114. MedicationRequest.supportingInformation | |
Definition | Include additional information (for example, patient height and weight) that supports the ordering of the medication. |
Control | 0..* |
Type | Reference(Resource) |
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:
|
115. 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(AUBodyHeight) |
116. 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(AUBodyWeight) |
117. MedicationRequest.authoredOn | |
Definition | The date (and perhaps time) when the prescription was initially written or authored on. |
Control | 0..1 |
Type | dateTime |
118. MedicationRequest.requester | |
Definition | The individual, organization or device that initiated the request and has responsibility for its activation. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) mps-1: onBehalfOf can only be specified if agent is practitioner or device (: (agent.resolve().empty()) or (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()) |
119. MedicationRequest.requester.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 |
120. MedicationRequest.requester.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
121. MedicationRequest.requester.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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
122. MedicationRequest.requester.agent | |
Definition | The healthcare professional responsible for authorizing the initial prescription. |
Control | 1..1 |
Type | Reference(Practitioner | Organization | Patient | RelatedPerson | Device) |
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. |
123. MedicationRequest.requester.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of. |
Control | 0..1 This element is affected by the following invariants: mps-1 |
Type | Reference(Organization) |
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. |
124. 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) |
125. MedicationRequest.reasonCode | |
Definition | The reason or the indication for ordering the medication. |
Control | 0..* |
Binding | The codes SHOULD be taken from https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1 |
Type | CodeableConcept |
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference. |
126. 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. |
127. MedicationRequest.note | |
Definition | Extra information about the prescription that could not be conveyed by the other attributes. |
Control | 0..* |
Type | Annotation |
128. MedicationRequest.dosageInstruction | |
Definition | Indicates how the medication is/was taken or should be taken by the patient. |
Control | 0..* This element is affected by the following invariants: ele-1 |
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() | (children().count() > id.count())) |
129. 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 | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
130. 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 |
131. MedicationRequest.dispenseRequest.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
132. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
133. 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. |
134. 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. |
Control | 0..1 |
Type | positiveInt |
Comments | If displaying "number of authorized fills", add 1 to this number. |
135. MedicationRequest.dispenseRequest.quantity | |
Definition | The amount that is to be dispensed for one fill. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
136. 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. |
137. MedicationRequest.dispenseRequest.performer | |
Definition | Indicates the intended dispensing Organization specified by the prescriber. |
Control | 0..1 |
Type | Reference(Organization) |
138. 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() | (children().count() > id.count())) |
139. 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 |
140. MedicationRequest.substitution.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user 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. |
141. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
142. MedicationRequest.substitution.allowed | |
Definition | True if the prescriber allows a different drug to be dispensed from what was prescribed. |
Control | 1..1 |
Type | boolean |
Is Modifier | true |
Comments | This element is labeled as a modifer because whether substitution is allow or not cannot be ignored. |
143. 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 |
144. MedicationRequest.priorPrescription | |
Definition | A link to a resource representing an earlier order related order or prescription. |
Control | 0..1 |
Type | Reference(MedicationRequest) |
145. 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 | Contraindication, Drug Utilization Review (DUR), Alert |
146. 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 may 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.). |