Profile: CareConnect-GPC-MedicationRequest-1
| CareConnect-GPC-MedicationRequest-1 (MedicationRequest) | C | MedicationRequest | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 1..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| repeatInformation | C | 0..1 | Extension(Complex) |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| numberOfRepeatPrescriptionsAllowed | S C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 1..1 | ||
| valueUnsignedInt | unsignedInt | ||
| numberOfRepeatPrescriptionsIssued | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueUnsignedInt | unsignedInt | ||
| authorisationExpiryDate | S C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueDateTime | dateTime | ||
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 | ||
| statusReason | S C | 0..1 | Extension(Complex) |
| id | 0..1 | string | |
| extension | C | 2..* | Extension |
| statusReason | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueCodeableConcept | CodeableConcept | ||
| statusChangeDate | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueDateTime | dateTime | ||
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 | ||
| prescriptionType | S C | 0..1 | Extension(CodeableConcept) |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | 1..* | Identifier | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| status | Σ ?! | 1..1 | codeBinding |
| statusReason | 0..1 | CodeableConcept | |
| intent | Σ ?! | 1..1 | codeBinding |
| category | 0..* | CodeableConcept | |
| priority | Σ | 0..1 | codeBinding |
| doNotPerform | Σ ?! | 0..1 | boolean |
| reported[x] | Σ | 0..1 | |
| reportedBoolean | boolean | ||
| reportedReference | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| medication[x] | Σ | 1..1 | |
| medicationCodeableConcept | CodeableConcept | ||
| medicationReference | Reference(Medication) | ||
| subject | Σ C | 1..1 | Reference(Group | Patient) |
| encounter | C | 0..1 | Reference(Encounter) |
| supportingInformation | C | 0..* | Reference(Resource) |
| authoredOn | Σ | 0..1 | dateTime |
| requester | Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| performer | C | 0..1 | Reference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| performerType | Σ | 0..1 | CodeableConcept |
| recorder | C | 0..1 | Reference(Practitioner | PractitionerRole) |
| reasonCode | 0..* | CodeableConcept | |
| reasonReference | C | 0..* | Reference(Condition | Observation) |
| instantiatesCanonical | Σ | 0..* | canonical |
| instantiatesUri | Σ | 0..* | uri |
| basedOn | S Σ C | 0..* | Reference(CarePlan) | Reference(http://hl7.org/fhir/StructureDefinition/ProcedureRequest) | Reference(http://hl7.org/fhir/StructureDefinition/ReferralRequest) | Reference(CareConnect-GPC-MedicationRequest-1) |
| groupIdentifier | S Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(CareConnect-GPC-Organization-1) |
| courseOfTherapyType | 0..1 | CodeableConcept | |
| insurance | C | 0..* | Reference(ClaimResponse | Coverage) |
| note | S | 0..* | Annotation |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| author[x] | Σ | 0..1 | |
| authorReference | Reference(RelatedPerson) | Reference(CareConnect-GPC-Patient-1) | Reference(CareConnect-GPC-Practitioner-1) | ||
| authorString | string | ||
| time | Σ | 0..1 | dateTime |
| text | Σ | 1..1 | markdown |
| dosageInstruction | 1..* | Dosage | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| sequence | Σ | 0..1 | integer |
| text | Σ | 1..1 | string |
| additionalInstruction | Σ | 0..* | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | Coding |
| snomedCT | Σ | 0..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| descriptionId | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueId | id | ||
| descriptionDisplay | C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 | ||
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..0 | string |
| code | Σ | 1..1 | code |
| display | Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| patientInstruction | S Σ | 0..1 | string |
| timing | Σ | 0..1 | Timing |
| asNeeded[x] | Σ | 0..1 | |
| asNeededBoolean | boolean | ||
| asNeededCodeableConcept | CodeableConcept | ||
| site | Σ | 0..1 | CodeableConcept |
| route | Σ | 0..1 | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | Coding |
| snomedCT | Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| descriptionId | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueId | id | ||
| descriptionDisplay | C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 | ||
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..0 | string |
| code | Σ | 1..1 | code |
| display | Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| method | Σ | 0..1 | CodeableConcept |
| doseAndRate | Σ | 0..* | Element |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| type | Σ | 0..1 | CodeableConcept |
| dose[x] | Σ | 0..1 | |
| doseQuantity | SimpleQuantity | ||
| doseRange | Range | ||
| rate[x] | Σ | 0..1 | |
| rateQuantity | SimpleQuantity | ||
| rateRange | Range | ||
| rateRatio | Ratio | ||
| maxDosePerPeriod | Σ C | 0..1 | Ratio |
| maxDosePerAdministration | Σ C | 0..1 | SimpleQuantity |
| maxDosePerLifetime | Σ C | 0..1 | SimpleQuantity |
| dispenseRequest | 1..1 | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| initialFill | 0..1 | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| quantity | C | 0..1 | SimpleQuantity |
| duration | C | 0..1 | Duration |
| dispenseInterval | C | 0..1 | Duration |
| validityPeriod | C | 1..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | Σ C | 1..1 | dateTime |
| end | Σ C | 0..1 | dateTime |
| numberOfRepeatsAllowed | 0..1 | unsignedInt | |
| quantity | S C | 0..1 | SimpleQuantity |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| quantityText | S C | 0..1 | Extension(string) |
| value | Σ | 0..1 | decimal |
| comparator | Σ ?! | 0..0 | codeBinding |
| unit | Σ | 0..1 | string |
| system | Σ C | 0..1 | uri |
| code | Σ | 0..1 | code |
| expectedSupplyDuration | S C | 0..1 | Duration |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| value | Σ | 1..1 | decimal |
| comparator | Σ ?! | 0..0 | codeBinding |
| unit | Σ | 0..1 | string |
| system | Σ C | 1..1 | uriFixed Value |
| code | Σ | 1..1 | codeBinding |
| performer | S C | 0..1 | Reference(CareConnect-GPC-Organization-1) |
| substitution | 0..1 | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| allowed[x] | 1..1 | ||
| allowedBoolean | boolean | ||
| allowedCodeableConcept | CodeableConcept | ||
| reason | 0..1 | CodeableConcept | |
| priorPrescription | C | 0..1 | Reference(CareConnect-GPC-MedicationRequest-1) |
| detectedIssue | S C | 0..* | Reference(DetectedIssue) |
| eventHistory | C | 0..* | Reference(Provenance) |
| status | 1.. | ||
| medication[x] | 0..* | ||
| medicationCodeableConcept | CodeableConcept | ||
| medicationReference | Reference(CareConnect-GPC-Medication-1) | ||
| subject | C | 0..* | Reference(Group) | Reference(CareConnect-GPC-Patient-1) |
| context | S C | 0..* | Reference(EpisodeOfCare) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) |
| authoredOn | 1.. | ||
| requester | S | ||
| recorder | C | 1..* | Reference(CareConnect-GPC-Practitioner-1) |
| reasonReference | C | 0..* | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1) |
| MedicationRequest | C | |||
| Short | Ordering of medication for patient or group | |||
| Definition | An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. | |||
| Cardinality | 0..* | |||
| Alias | Prescription, Order | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.id | Σ | |||
| Short | Logical id of this artifact | |||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta | Σ | |||
| Short | Metadata about the resource | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | Meta | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.meta.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta.versionId | Σ | |||
| Short | Version specific identifier | |||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Summary | True | |||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta.lastUpdated | Σ | |||
| Short | When the resource version last changed | |||
| Definition | When the resource last changed - e.g. when the version changed. | |||
| Cardinality | 0..1 | |||
| Type | instant | |||
| Summary | True | |||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta.source | Σ | |||
| Short | Identifies where the resource comes from | |||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta.profile | Σ | |||
| Short | Profiles this resource claims to conform to | |||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | |||
| Cardinality | 1..* | |||
| Type | canonical(StructureDefinition) | |||
| Summary | True | |||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta.security | Σ | |||
| Short | Security Labels applied to this resource | |||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | |||
| Cardinality | 0..* | |||
| Type | Coding | |||
| Binding | Security Labels from the Healthcare Privacy and Security Classification System. | |||
| Summary | True | |||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.meta.tag | Σ | |||
| Short | Tags applied to this resource | |||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | |||
| Cardinality | 0..* | |||
| Type | Coding | |||
| Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||
| Summary | True | |||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.implicitRules | Σ ?! | |||
| Short | A set of rules under which this content was created | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Modifier | True | |||
| Summary | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.language | ||||
| Short | Language of the resource content | |||
| Definition | The base language in which the resource is written. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | A human language. Binding extensions
| |||
| 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). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.text | ||||
| Short | Text summary of the resource, for human interpretation | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | Narrative | |||
| Alias | 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 information is added later. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.contained | ||||
| Short | Contained, inline Resources | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Resource | |||
| Alias | 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |||
| Mappings |
| |||
| MedicationRequest.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation | C | |||
| Short | Medication repeat information | |||
| Definition | Medication repeat information. | |||
| Cardinality | 0..1 | |||
| Type | Extension(Complex) | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 1..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed | S C | |||
| Short | Number of repeat prescriptions authorised | |||
| Definition | Number of repeat prescriptions authorised. | |||
| Cardinality | 0..1 | |||
| Type | Extension | |||
| Must Support | True | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | numberOfRepeatPrescriptionsAllowed | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.value[x] | ||||
| Short | Number of issues authorised | |||
| Definition | Number of issues authorised. | |||
| Cardinality | 1..1 | |||
| Type | unsignedInt | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued | C | |||
| Short | Number of repeat prescriptions issued | |||
| Definition | Number of repeat prescriptions issued. | |||
| Cardinality | 1..1 | |||
| Type | Extension | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | numberOfRepeatPrescriptionsIssued | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.value[x] | ||||
| Short | Number of issues issued | |||
| Definition | Number of issues issued. | |||
| Cardinality | 0..1 | |||
| Type | unsignedInt | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate | S C | |||
| Short | Repeat prescription review date | |||
| Definition | Repeat prescription review date. | |||
| Cardinality | 0..1 | |||
| Type | Extension | |||
| Must Support | True | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | authorisationExpiryDate | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.value[x] | ||||
| Short | Repeat review date | |||
| Definition | Repeat review date. | |||
| Cardinality | 0..1 | |||
| Type | dateTime | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationRepeatInformation-1 | |||
| Mappings |
| |||
| MedicationRequest.extension:repeatInformation.value[x] | ||||
| Short | Value of extension | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..0 | |||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason | S C | |||
| Short | To record the reason the medication (plan or order) was stopped and the date this occurred | |||
| Definition | To record the reason the medication (plan or order) was stopped and the date this occurred. | |||
| Cardinality | 0..1 | |||
| Type | Extension(Complex) | |||
| Must Support | True | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 2..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusReason | C | |||
| Short | Reason for current status | |||
| Definition | Reason for current status. | |||
| Cardinality | 1..1 | |||
| Type | Extension | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusReason.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusReason.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusReason.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | statusReason | |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusReason.value[x] | ||||
| Short | To record the reason the medication (plan or order) was stopped | |||
| Definition | To record the reason the medication (plan or order) was stopped. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusChangeDate | C | |||
| Short | To record the date this occurred | |||
| Definition | To record the date this occurred. | |||
| Cardinality | 1..1 | |||
| Type | Extension | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusChangeDate.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusChangeDate.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusChangeDate.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | statusChangeDate | |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.extension:statusChangeDate.value[x] | ||||
| Short | To record the date this occurred | |||
| Definition | To record the date this occurred. | |||
| Cardinality | 0..1 | |||
| Type | dateTime | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationStatusReason-1 | |||
| Mappings |
| |||
| MedicationRequest.extension:statusReason.value[x] | ||||
| Short | Value of extension | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..0 | |||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.extension:prescriptionType | S C | |||
| Short | To record the type of prescription | |||
| Definition | To record the type of prescription. | |||
| Cardinality | 0..1 | |||
| Type | Extension(CodeableConcept) | |||
| Must Support | True | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.modifierExtension | ?! C | |||
| Short | Extensions that cannot be ignored | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Alias | extensions, user content | |||
| 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. | |||
| 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.identifier | ||||
| Short | External ids for this request | |||
| 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. | |||
| Cardinality | 1..* | |||
| Type | Identifier | |||
| Comments | This is a business identifier, not a resource identifier. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.identifier.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Summary | True | |||
| 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. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MedicationRequest.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 1..1 | |||
| Type | string | |||
| Summary | True | |||
| 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MedicationRequest.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(Organization) | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.status | Σ ?! | |||
| Short | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown | |||
| Definition | A code specifying the current state of the order. Generally, this will be active or completed state. | |||
| Cardinality | 1..1 | |||
| Type | code | |||
| Binding | A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | |||
| Modifier | True | |||
| Summary | True | |||
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.statusReason | ||||
| Short | Reason for current status | |||
| Definition | Captures the reason for the current state of the MedicationRequest. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | Identifies the reasons for a given status. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.intent | Σ ?! | |||
| Short | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | |||
| Definition | Whether the request is a proposal, plan, or an original order. | |||
| Cardinality | 1..1 | |||
| Type | code | |||
| Binding | The kind of medication order. | |||
| Modifier | True | |||
| Summary | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.category | ||||
| Short | Type of medication usage | |||
| Definition | Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). | |||
| Cardinality | 0..* | |||
| Type | CodeableConcept | |||
| Binding | 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. | |||
| Comments | The category can be used to include where the medication is expected to be consumed or other types of requests. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.priority | Σ | |||
| Short | routine | urgent | asap | stat | |||
| Definition | Indicates how quickly the Medication Request should be addressed with respect to other requests. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the level of importance to be assigned to actioning the request. | |||
| Summary | True | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.doNotPerform | Σ ?! | |||
| Short | True if request is prohibiting action | |||
| Definition | If true indicates that the provider is asking for the medication request not to occur. | |||
| Cardinality | 0..1 | |||
| Type | boolean | |||
| Modifier | True | |||
| Summary | True | |||
| Comments | If do not perform is not specified, the request is a positive request e.g. "do perform". | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.reported[x] | Σ | |||
| Short | Reported rather than primary record | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | boolean | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.medication[x] | Σ | |||
| Short | Medication to be taken | |||
| 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. | |||
| Cardinality | 1..1 | |||
| Type | CodeableConcept | Reference(Medication) | |||
| Binding | A coded concept identifying substance or product that can be ordered. | |||
| Summary | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.subject | Σ C | |||
| Short | Who or group medication request is for | |||
| Definition | A link to a resource representing the person or set of individuals to whom the medication will be given. | |||
| Cardinality | 1..1 | |||
| Type | Reference(Group | Patient) | |||
| Summary | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.encounter | C | |||
| Short | Encounter created as part of encounter/admission/stay | |||
| Definition | The Encounter during which this [x] was created or to which the creation of this record is tightly associated. | |||
| Cardinality | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.supportingInformation | C | |||
| Short | Information to support ordering of the medication | |||
| Definition | Include additional information (for example, patient height and weight) that supports the ordering of the medication. | |||
| Cardinality | 0..* | |||
| Type | Reference(Resource) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.authoredOn | Σ | |||
| Short | When request was initially authored | |||
| Definition | The date (and perhaps time) when the prescription was initially written or authored on. | |||
| Cardinality | 0..1 | |||
| Type | dateTime | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.requester | Σ C | |||
| Short | Who/What requested the Request | |||
| Definition | The individual, organization, or device that initiated the request and has responsibility for its activation. | |||
| Cardinality | 0..1 | |||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | |||
| Summary | True | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.performer | C | |||
| Short | Intended performer of administration | |||
| Definition | The specified desired performer of the medication treatment (e.g. the performer of the medication administration). | |||
| Cardinality | 0..1 | |||
| Type | Reference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.performerType | Σ | |||
| Short | Desired kind of performer of the medication administration | |||
| Definition | Indicates the type of performer of the administration of the medication. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | Identifies the type of individual that is desired to administer the medication. | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.recorder | C | |||
| Short | Person who entered the request | |||
| Definition | The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. | |||
| Cardinality | 0..1 | |||
| Type | Reference(Practitioner | PractitionerRole) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.reasonCode | ||||
| Short | Reason or indication for ordering or not ordering the medication | |||
| Definition | The reason or the indication for ordering or not ordering the medication. | |||
| Cardinality | 0..* | |||
| Type | CodeableConcept | |||
| Binding | A coded concept indicating why the medication was ordered. | |||
| Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.reasonReference | C | |||
| Short | Condition or observation that supports why the prescription is being written | |||
| Definition | Condition or observation that supports why the medication was ordered. | |||
| Cardinality | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.instantiatesCanonical | Σ | |||
| Short | Instantiates FHIR protocol or definition | |||
| Definition | The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest. | |||
| Cardinality | 0..* | |||
| Type | canonical | |||
| Summary | True | |||
| Comments | ||||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.instantiatesUri | Σ | |||
| Short | Instantiates external protocol or definition | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | uri | |||
| Summary | True | |||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.basedOn | S Σ C | |||
| Short | What request fulfills | |||
| Definition | A plan or request that is fulfilled in whole or in part by this medication request. | |||
| Cardinality | 0..* | |||
| Type | Reference(CarePlan) | Reference(http://hl7.org/fhir/StructureDefinition/ProcedureRequest) | Reference(http://hl7.org/fhir/StructureDefinition/ReferralRequest) | Reference(CareConnect-GPC-MedicationRequest-1) | |||
| Must Support | True | |||
| Summary | True | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier | S Σ | |||
| Short | Composite request this is part of | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Must Support | True | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| 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. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.groupIdentifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(CareConnect-GPC-Organization-1) | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.courseOfTherapyType | ||||
| Short | Overall pattern of medication administration | |||
| Definition | The description of the overall patte3rn of the administration of the medication to the patient. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | Identifies the overall pattern of medication administratio. | |||
| Comments | This attribute should not be confused with the protocol of the medication. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.insurance | C | |||
| Short | Associated insurance coverage | |||
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. | |||
| Cardinality | 0..* | |||
| Type | Reference(ClaimResponse | Coverage) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.note | S | |||
| Short | Information about the prescription | |||
| Definition | Extra information about the prescription that could not be conveyed by the other attributes. | |||
| Cardinality | 0..* | |||
| Type | Annotation | |||
| Must Support | True | |||
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.note.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.note.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.note.author[x] | Σ | |||
| Short | Individual responsible for the annotation | |||
| Definition | The individual responsible for making the annotation. | |||
| Cardinality | 0..1 | |||
| Type | Reference(RelatedPerson) | Reference(CareConnect-GPC-Patient-1) | Reference(CareConnect-GPC-Practitioner-1) | string | |||
| Summary | True | |||
| Comments | Organization is used when there's no need for specific attribution as to who made the comment. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.note.time | Σ | |||
| Short | When the annotation was made | |||
| Definition | Indicates when this particular annotation was made. | |||
| Cardinality | 0..1 | |||
| Type | dateTime | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.note.text | Σ | |||
| Short | The annotation - text content (as markdown) | |||
| Definition | The text of the annotation in markdown format. | |||
| Cardinality | 1..1 | |||
| Type | markdown | |||
| Summary | True | |||
| Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction | ||||
| Short | How the medication should be taken | |||
| Definition | Indicates how the medication is to be used by the patient. | |||
| Cardinality | 1..* | |||
| Type | Dosage | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| 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. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.sequence | Σ | |||
| Short | The order of the dosage instructions | |||
| Definition | Indicates the order in which the dosage instructions should be applied or interpreted. | |||
| Cardinality | 0..1 | |||
| Type | integer | |||
| Summary | True | |||
| Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. | |||
| Comments | 32 bit number; for values larger than this, use decimal | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.text | Σ | |||
| Short | Free text dosage instructions e.g. SIG | |||
| Definition | Free text dosage instructions e.g. SIG. | |||
| Cardinality | 1..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction | Σ | |||
| Short | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | |||
| Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). | |||
| Cardinality | 0..* | |||
| Type | CodeableConcept | |||
| Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | |||
| Summary | True | |||
| Requirements | Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. | |||
| Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding | Σ | |||
| Short | Code defined by a terminology system | |||
| Definition | A reference to a code defined by a terminology system. | |||
| Cardinality | 0..* | |||
| Type | Coding | |||
| Summary | True | |||
| 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. | |||
| Slicing | Unordered, Open, by system(Value) | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT | Σ | |||
| Short | Code defined by a terminology system | |||
| Definition | A reference to a code defined by a terminology system. | |||
| Cardinality | 0..1 | |||
| Type | Coding | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID | C | |||
| Short | The SNOMED CT Description ID for the display | |||
| Definition | The SNOMED CT Description ID for the display. | |||
| Cardinality | 0..1 | |||
| Type | Extension(Complex) | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 1..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId | C | |||
| Short | The SNOMED CT Description ID | |||
| 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. | |||
| Cardinality | 1..1 | |||
| Type | Extension | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionId | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x] | ||||
| Short | The SNOMED CT Description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay | C | |||
| Short | The SNOMED CT display for the description ID | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | Extension | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionDisplay | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x] | ||||
| Short | The SNOMED CT display for the description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID.value[x] | ||||
| Short | Value of extension | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..0 | |||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | code | CodeableConcept | Coding | ContactPoint | Count | date | dateTime | decimal | Distance | Duration | HumanName | id | Identifier | instant | integer | markdown | Money | oid | Period | positiveInt | Quantity | Range | Ratio | Reference | SampledData | Signature | string | time | Timing | unsignedInt | uri | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.system | Σ | |||
| Short | Identity of the terminology system | |||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Fixed Value | http://snomed.info/sct | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.version | Σ | |||
| Short | Version of the system - if relevant | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | string | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.code | Σ | |||
| Short | Symbol in syntax defined by the system | |||
| 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). | |||
| Cardinality | 1..1 | |||
| Type | code | |||
| Summary | True | |||
| Requirements | Need to refer to a particular code in the system. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.display | Σ | |||
| Short | Representation defined by the system | |||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||
| Cardinality | 1..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.userSelected | Σ | |||
| Short | If this coding was chosen directly by the user | |||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||
| Cardinality | 0..1 | |||
| Type | boolean | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.additionalInstruction.text | Σ | |||
| Short | Plain text representation of the concept | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.patientInstruction | S Σ | |||
| Short | Patient or consumer oriented instructions | |||
| Definition | Instructions in terms that are understood by the patient or consumer. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Must Support | True | |||
| Summary | True | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.timing | Σ | |||
| Short | When medication should be administered | |||
| Definition | When medication should be administered. | |||
| Cardinality | 0..1 | |||
| Type | Timing | |||
| Summary | True | |||
| Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | |||
| Comments | This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.asNeeded[x] | Σ | |||
| Short | Take "as needed" (for x) | |||
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | |||
| Cardinality | 0..1 | |||
| Type | boolean | CodeableConcept | |||
| Binding | A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||
| Summary | True | |||
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.site | Σ | |||
| Short | Body site to administer to | |||
| Definition | Body site to administer to. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded concept describing the site location the medicine enters into or onto the body. | |||
| Summary | True | |||
| Requirements | A coded specification of the anatomic site where the medication first enters the body. | |||
| Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route | Σ | |||
| Short | How drug should enter body | |||
| Definition | How drug should enter body. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||
| Summary | True | |||
| Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. | |||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding | Σ | |||
| Short | Code defined by a terminology system | |||
| Definition | A reference to a code defined by a terminology system. | |||
| Cardinality | 0..* | |||
| Type | Coding | |||
| Summary | True | |||
| 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. | |||
| Slicing | Unordered, Open, by system(Value) | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT | Σ | |||
| Short | Code defined by a terminology system | |||
| Definition | A reference to a code defined by a terminology system. | |||
| Cardinality | 0..1 | |||
| Type | Coding | |||
| Binding | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID | C | |||
| Short | The SNOMED CT Description ID for the display | |||
| Definition | The SNOMED CT Description ID for the display. | |||
| Cardinality | 0..1 | |||
| Type | Extension(Complex) | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 1..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId | C | |||
| Short | The SNOMED CT Description ID | |||
| 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. | |||
| Cardinality | 1..1 | |||
| Type | Extension | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionId | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x] | ||||
| Short | The SNOMED CT Description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay | C | |||
| Short | The SNOMED CT display for the description ID | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | Extension | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionDisplay | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x] | ||||
| Short | The SNOMED CT display for the description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID.value[x] | ||||
| Short | Value of extension | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..0 | |||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | code | CodeableConcept | Coding | ContactPoint | Count | date | dateTime | decimal | Distance | Duration | HumanName | id | Identifier | instant | integer | markdown | Money | oid | Period | positiveInt | Quantity | Range | Ratio | Reference | SampledData | Signature | string | time | Timing | unsignedInt | uri | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.system | Σ | |||
| Short | Identity of the terminology system | |||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Fixed Value | http://snomed.info/sct | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.version | Σ | |||
| Short | Version of the system - if relevant | |||
| 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. | |||
| Cardinality | 0..0 | |||
| Type | string | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.code | Σ | |||
| Short | Symbol in syntax defined by the system | |||
| 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). | |||
| Cardinality | 1..1 | |||
| Type | code | |||
| Summary | True | |||
| Requirements | Need to refer to a particular code in the system. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.display | Σ | |||
| Short | Representation defined by the system | |||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||
| Cardinality | 1..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.coding:snomedCT.userSelected | Σ | |||
| Short | If this coding was chosen directly by the user | |||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||
| Cardinality | 0..1 | |||
| Type | boolean | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.route.text | Σ | |||
| Short | Plain text representation of the concept | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.method | Σ | |||
| Short | Technique for administering medication | |||
| Definition | Technique for administering medication. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded concept describing the technique by which the medicine is administered. | |||
| Summary | True | |||
| Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. | |||
| Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.doseAndRate | Σ | |||
| Short | Amount of medication administered | |||
| Definition | The amount of medication administered. | |||
| Cardinality | 0..* | |||
| Type | Element | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.doseAndRate.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.doseAndRate.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.doseAndRate.type | Σ | |||
| Short | The kind of dose or rate specified | |||
| Definition | The kind of dose or rate specified, for example, ordered or calculated. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | The kind of dose or rate specified. | |||
| Summary | True | |||
| Requirements | If the type is not populated, assume to be "ordered". | |||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.doseAndRate.dose[x] | Σ | |||
| Short | Amount of medication per dose | |||
| Definition | Amount of medication per dose. | |||
| Cardinality | 0..1 | |||
| Type | SimpleQuantity | Range | |||
| Summary | True | |||
| Requirements | The amount of therapeutic or other substance given at one administration event. | |||
| Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.doseAndRate.rate[x] | Σ | |||
| Short | Amount of medication per unit of time | |||
| Definition | Amount of medication per unit of time. | |||
| Cardinality | 0..1 | |||
| Type | SimpleQuantity | Range | Ratio | |||
| Summary | True | |||
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | |||
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.maxDosePerPeriod | Σ C | |||
| Short | Upper limit on medication per unit of time | |||
| Definition | Upper limit on medication per unit of time. | |||
| Cardinality | 0..1 | |||
| Type | Ratio | |||
| Summary | True | |||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. | |||
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.maxDosePerAdministration | Σ C | |||
| Short | Upper limit on medication per administration | |||
| Definition | Upper limit on medication per administration. | |||
| Cardinality | 0..1 | |||
| Type | SimpleQuantity | |||
| Summary | True | |||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. | |||
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dosageInstruction.maxDosePerLifetime | Σ C | |||
| Short | Upper limit on medication per lifetime of the patient | |||
| Definition | Upper limit on medication per lifetime of the patient. | |||
| Cardinality | 0..1 | |||
| Type | SimpleQuantity | |||
| Summary | True | |||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. | |||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest | ||||
| Short | Medication supply authorization | |||
| 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. | |||
| Cardinality | 1..1 | |||
| Type | BackboneElement | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| 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. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.initialFill | ||||
| Short | First fill details | |||
| Definition | Indicates the quantity or duration for the first dispense of the medication. | |||
| Cardinality | 0..1 | |||
| Type | BackboneElement | |||
| Comments | If populating this element, either the quantity or the duration must be included. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.initialFill.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.initialFill.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.initialFill.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| 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. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.initialFill.quantity | C | |||
| Short | First fill quantity | |||
| Definition | The amount or quantity to provide as part of the first dispense. | |||
| Cardinality | 0..1 | |||
| Type | SimpleQuantity | |||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.initialFill.duration | C | |||
| Short | First fill duration | |||
| Definition | The length of time that the first dispense is expected to last. | |||
| Cardinality | 0..1 | |||
| Type | Duration | |||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.dispenseInterval | C | |||
| Short | Minimum period of time between dispenses | |||
| Definition | The minimum period of time that must occur between dispenses of the medication. | |||
| Cardinality | 0..1 | |||
| Type | Duration | |||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.validityPeriod | C | |||
| Short | Time period supply is authorized for | |||
| Definition | This indicates the validity period of a prescription (stale dating the Prescription). | |||
| Cardinality | 1..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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.validityPeriod.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.validityPeriod.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.validityPeriod.start | Σ C | |||
| Short | Starting time with inclusive boundary | |||
| Definition | The start of the period. The boundary is inclusive. | |||
| Cardinality | 1..1 | |||
| Type | dateTime | |||
| Summary | True | |||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, per-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.validityPeriod.end | Σ C | |||
| Short | End time with inclusive boundary, if not ongoing | |||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | |||
| Cardinality | 0..1 | |||
| Type | dateTime | |||
| Summary | True | |||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | |||
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, per-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.numberOfRepeatsAllowed | ||||
| Short | Number of refills authorized | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | unsignedInt | |||
| Comments | If displaying "number of authorized fills", add 1 to this number. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity | S C | |||
| Short | Amount of medication to supply per dispense | |||
| Definition | The amount that is to be dispensed for one fill. | |||
| Cardinality | 0..1 | |||
| Type | SimpleQuantity | |||
| Must Support | True | |||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.extension:quantityText | S C | |||
| Short | Quantity representation | |||
| Definition | Quantity representation. | |||
| Cardinality | 0..1 | |||
| Type | Extension(string) | |||
| Must Support | True | |||
| Alias | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.value | Σ | |||
| Short | Numerical value (with implicit precision) | |||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | |||
| Cardinality | 0..1 | |||
| Type | decimal | |||
| Summary | True | |||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | |||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.comparator | Σ ?! | |||
| Short | < | <= | >= | > - how to understand the value | |||
| Definition | Not allowed to be used in this context | |||
| Cardinality | 0..0 | |||
| Type | code | |||
| Binding | How the Quantity should be understood and represented. | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Meaning when missing | If there is no comparator, then there is no modification of the value | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.unit | Σ | |||
| Short | Unit representation | |||
| Definition | A human-readable form of the unit. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.system | Σ C | |||
| Short | System that defines coded unit form | |||
| Definition | The identification of the system that provides the coded form of the unit. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | Need to know the system that defines the coded form of the unit. | |||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, qty-3 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.quantity.code | Σ | |||
| Short | Coded form of the unit | |||
| Definition | A computer processable form of the unit in some unit representation system. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Summary | True | |||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | |||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration | S C | |||
| Short | Number of days supply per dispense | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | Duration | |||
| Must Support | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.value | Σ | |||
| Short | Numerical value (with implicit precision) | |||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | |||
| Cardinality | 1..1 | |||
| Type | decimal | |||
| Summary | True | |||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | |||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.comparator | Σ ?! | |||
| Short | < | <= | >= | > - how to understand the value | |||
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | |||
| Cardinality | 0..0 | |||
| Type | code | |||
| Binding | How the Quantity should be understood and represented. | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Meaning when missing | If there is no comparator, then there is no modification of the value | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.unit | Σ | |||
| Short | Unit representation | |||
| Definition | A human-readable form of the unit. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.system | Σ C | |||
| Short | System that defines coded unit form | |||
| Definition | The identification of the system that provides the coded form of the unit. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | Need to know the system that defines the coded form of the unit. | |||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, qty-3 | |||
| Constraints |
| |||
| Fixed Value | http://unitsofmeasure.org | |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.expectedSupplyDuration.code | Σ | |||
| Short | Coded form of the unit | |||
| Definition | A computer processable form of the unit in some unit representation system. | |||
| Cardinality | 1..1 | |||
| Type | code | |||
| Binding | A unit of time (units from UCUM). | |||
| Summary | True | |||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | |||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.dispenseRequest.performer | S C | |||
| Short | Intended dispenser | |||
| Definition | Indicates the intended dispensing Organization specified by the prescriber. | |||
| Cardinality | 0..1 | |||
| Type | Reference(CareConnect-GPC-Organization-1) | |||
| Must Support | True | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.substitution | ||||
| Short | Any restrictions on medication 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. | |||
| Cardinality | 0..1 | |||
| Type | BackboneElement | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.substitution.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MedicationRequest.substitution.extension | C | |||
| Short | Additional content defined by implementations | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | 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 | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.substitution.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| 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. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.substitution.allowed[x] | ||||
| Short | Whether substitution is allowed or not | |||
| Definition | True if the prescriber allows a different drug to be dispensed from what was prescribed. | |||
| Cardinality | 1..1 | |||
| Type | boolean | CodeableConcept | |||
| Binding | Identifies the type of substitution allowed. | |||
| Comments | This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.substitution.reason | ||||
| Short | Why should (not) substitution be made | |||
| Definition | Indicates the reason for the substitution, or why substitution must or must not be performed. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.priorPrescription | C | |||
| Short | An order/prescription that is being replaced | |||
| Definition | A link to a resource representing an earlier order related order or prescription. | |||
| Cardinality | 0..1 | |||
| Type | Reference(CareConnect-GPC-MedicationRequest-1) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.detectedIssue | S C | |||
| Short | Clinical Issue with action | |||
| 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. | |||
| Cardinality | 0..* | |||
| Type | Reference(DetectedIssue) | |||
| Must Support | True | |||
| Alias | Contraindication, Drug 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.eventHistory | C | |||
| Short | A list of events of interest in the lifecycle | |||
| 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. | |||
| Cardinality | 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.). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.status | ||||
| Cardinality | 1 | |||
| MedicationRequest.medication[x] | ||||
| Short | Base for all elements | |||
| Definition | Base definition for all elements in a resource. | |||
| Cardinality | 0..* | |||
| Type | CodeableConcept | Reference(CareConnect-GPC-Medication-1) | |||
| Binding | ||||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.subject | C | |||
| Short | A reference from one resource to another | |||
| Definition | A reference from one resource to another. | |||
| Cardinality | 0..* | |||
| Type | Reference(Group) | Reference(CareConnect-GPC-Patient-1) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.context | S C | |||
| Short | A reference from one resource to another | |||
| Definition | A reference from one resource to another. | |||
| Cardinality | 0..* | |||
| Type | Reference(EpisodeOfCare) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) | |||
| Must Support | True | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.authoredOn | ||||
| Cardinality | 1 | |||
| MedicationRequest.requester | S | |||
| Must Support | True | |||
| MedicationRequest.recorder | C | |||
| Short | A reference from one resource to another | |||
| Definition | A reference from one resource to another. | |||
| Cardinality | 1..* | |||
| Type | Reference(CareConnect-GPC-Practitioner-1) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MedicationRequest.reasonReference | C | |||
| Short | A reference from one resource to another | |||
| Definition | A reference from one resource to another. | |||
| Cardinality | 0..* | |||
| Type | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1) | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
Reference
Canonical URI: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationRequest-1
The canonical URI is the stable FHIR identifier for this profile and is not currently available as a browsable web page.
Related links
DAPB4013: Medicine and Allergy/Intolerance Data Transfer
CareConnect-MedicationRequest-1
CareConnect-GPC-MedicationRequest-1
Related UK Core profile: UKCore-MedicationRequest
The UK Core profile is included for reference. It is based on FHIR R4 and are not part of the GP Connect STU3 standard and must not be used as the conformance or validation profile for GP Connect STU3 resources.
Overarching principles
When populating the MedicationRequest profile it may appear that fields are duplicated in other associated resources. This is by design and has two benefits:
- provides context for each individual resource
- enables consumers to know that if no data has been populated it was because no data was available
This leads to the following two principles that MUST be applied when populating MedicationRequest profiles:
- All mandatory fields MUST be populated.
- Required fields MUST be populated where the data exists in the system
Data model element usage
| Element | Use | CareConnect (STU3) | UK Core (R4) |
|---|---|---|---|
| id | |||
| meta.versionId | |||
| meta.lastUpdated | |||
| meta.profile | |||
| meta.security | |||
| meta.tag | |||
| extension(repeatInformation) | |||
| extension(statusReason) | |||
| extension(prescriptionType) | |||
| identifier | |||
| definition | |||
| basedOn | |||
| groupIdentifier | |||
| status | |||
| intent | |||
| category | |||
| priority | |||
| medication | |||
| subject | |||
| context | |||
| supportingInformation | |||
| authoredOn | |||
| requester | |||
| recorder | |||
| reasonCode | |||
| note | |||
| dosageInstruction | |||
| dispenseRequest.validityPeriod | |||
| dispenseRequest.numberOfRepeatsAllowed | |||
| dispenseRequest.quantity | |||
| dispenseRequest.performer | |||
| substitution | |||
| priorPrescription | |||
| detectedIssue | |||
| eventHistory |
id
Usage
Optional
Guidance
The id is the logical identifier for the CareConnect-GPC-MedicationRequest-1 profile.
Example
<id value="5b23906c-22b7-47dd-810b-5cbaab16a8cc" />
meta.profile
Usage
Mandatory
Guidance
The meta.profile contains a fixed value of the URL for the CareConnect-GPC-MedicationRequest-1 profile.
Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-MedicationRequest-1" /> </meta>
meta.security
Usage
Optional
Guidance
The security label(s) applicable to the resource.
See Resources not to be disclosed to a patient for more details on how to populate the element.
Example
<meta> <security> <system value="http://hl7.org/fhir/v3/ActCode"/> <code value="NOPAT"/> <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/> </security> </meta>
meta.tag
Usage
Optional
Guidance
A use-case for the meta.tag element within GP Connect has not been defined.
Example
<meta> <tag> <coding> <system value="http://hl7.org/fhir/common-tags" /> <code value="actionable" /> <display value="Actionable" /> </coding> </tag> </meta>
extension(repeatInformation)
Usage
Required
Guidance
Only populate for a medication request with an intent that has been set to plan.
intent of order, then none of the repeatInformation fields are populated.
numberOfRepeatPrescriptionsAllowed
The number of repeat issues authorised if specified.
- This MUST be present where a repeat is authorised for a defined number of issues.
- It MUST NOT be specified for acute prescriptions or where the number of repeat issues has not been defined. There is no concept of an initial dispense in GP Connect usage. Therefore, the
numberOfRepeatsallowed is the total number of allowed issues.
numberOfRepeatPrescriptionsIssued
Running total of number of issues made against a repeat authorisation.
- This MUST be zero, if not yet issued.
authorisationExpiryDate
The date a repeat prescription authorisation will expire.
- Only populate for a medication request with an
intentset toplan.
<extension> <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationRepeatInformation-1" /> <!-- number of repeat Rx allowed --> <extension> <url value="numberOfRepeatPrescriptionsAllowed" /> <valuePositiveInt value="3"> </extension> <!-- number of repeat Rx issued --> <extension> <url value="numberOfRepeatPrescriptionsIssued" /> <valuePositiveInt value="0" /> </extension> <!-- authorisation expiry date --> <extension> <url value="authorisationExpiryDate" /> <valueDateTime value="2023-01-13T00:00:00Z" /> </extension> </extension>
extension(statusReason)
Usage
Required
Guidance
A coded reason for the current state of the medication request.
Should only be populated when the status is on-hold, cancelled or stopped and when the medication request intent is set to plan.
Example
<extension> <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationStatusReason-1" /> <extension> <url value="statusReason" /> <valueCodeableConcept> <coding value="salg" /> <text value="Allergy" /> </valueCodeableConcept> </extension> </extension>
extension(prescriptionType)
Usage
Required
Guidance
- acute
- repeat
- repeat dispensing
- delayed prescribing.
If UK Core R4 is extended to support this type of data then the extension name should ideally not be called prescriptionType as it confused with a different legacy HL7v3 vocabulary for prescriptionType which serves a different purpose.
This element provides an explicit repeat/acute flag rather than deriving it from presence of extension elements or repeatNumber.
In exceptional cases where for legacy data there is no prescriptionType recorded in the system then this MUST not populate the element and the consumer SHOULD use the text No information available.
Example
<extension> <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-PrescriptionType-1" /> <valueCodeableConcept> <system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-PrescriptionType-1" /> <code value="acute" /> </valueCodeableConcept> </extension>
identifier
Usage
Mandatory
Guidance
This identifier element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.
Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.
If the EPS identifier is present then the identifier.value is where the EPS ID SHOULD also be added. The codeSystem for this identifier is https://fhir.nhs.uk/Id/prescription-order-item-number
Example
<identifier> <system value="https://fhir.nhs.uk/Id/prescription-order-item-number" /> <value value="9b4ecfde-124e-4e25-8606-a36385ce1ecc" /> </identifier>
basedOn
Usage
Required
Guidance
This field is used to create the links between MedicationRequest profiles to represent the medication ordering process as described here.
This MUST be used when a profile has an intent element that is set to order and is basedOn a MedicationRequest profile that has an intent set to plan.
MedicationRequest with intent of plan.
Example
<basedOn> <reference value="medication-request-5485984" /> </basedOn>
groupIdentifier
Usage
Required
Guidance
This element SHOULD be populated if the medication request has been prescribed via the Electronic Prescription Service (EPS).
If the EPS identifier is present then the identifier.value is where the EPS ID SHOULD also be added. The codeSystem for this identifier is https://fhir.nhs.uk/Id/prescription-order-item-number
Example
<groupIdentifier> <system value="https://fhir.nhs.uk/Id/prescription-order-item-number" /> <value value="9b4ecfde-124e-4e25-8606-a36385ce1ecc" /> </groupIdentifier>
status
Usage
Mandatory
Guidance
The status of the authorisation within GP Connect will be one of active, completed or stopped:
active- representing an active authorisation - used for active medications/medical devicescompleted- representing an authorisation which has run its coursestopped- representing an authorisation which has been discontinued, cancelled or stopped
For MedicationRequest instances where intent is set to plan:
- For repeats and repeat dispensed the status refers to the status of the plan (the entire cycle of prescriptions)
- For acutes the status refers to the status of the prescription issue
For MedicationRequest instances where intent is set to order:
- The status refers to the status of the prescription issue
- Where the plan has been discontinued then the status should not be updated to
stopped
intent
Usage
Mandatory
Guidance
Used to distinguish between authorisations and issues.
Use one of plan or order:
planrepresents an authorisation of a medication or medical device.orderrepresents a prescription or issue of a medication or medical device.
Example
<intent value="order" />
medication
Usage
Mandatory
Guidance
The medication or medical device the authorisation is for.
The Medication profile provides the coded representation of the medication or medical device.
Example
<medication> <coding> <system value="http://snomed.info/sct" /> <code value="195967001" /> <display value="Penicillin" /> </coding> </medication>
subject
Usage
Mandatory
Guidance
A reference to the patient who the medication or medical device is for - that is, to whom it will be administered.
Example
<subject> <identifier> <extension url="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1" /> <code value="01" /> <display value="Number present and verified" /> </coding> <text value="Number present and verified" /> </valueCodeableConcept> </extension> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9989453456" /> </identifier> </subject>
context
Usage
Required
Guidance
The consultation when the medication/medical device was authorised.
- For a
MedicationRequestwith anintent=planthis is the consultation where the plan was authorised. - For a
MedicationRequestwith anintent=orderthis is the consultation where the specific issue was authorised
Example
<context> <identifier> <system value="https://hospital.example/visit-number" /> <value value="visit-00425123" /> </identifier> </context>
requester
Usage
Required
Guidance
Person and their organization requesting authorisation for prescription.
May not always be the user who entered the record on the system but, where a system supports attribution to a responsible clinician, the attributed clinician MUST be referenced here.
If it was prescribed at another practice and has been imported via GP2GP. In that case, the onBehalfOf MUST be completed with a reference to the other organisation.
Example
<requester> <agent> <identifier> <system value="https://fhir.hl7.org.uk/Id/gmc-number" /> <value value="00143922" /> </identifier> </agent> </requester>
recorder
Usage
Mandatory
Guidance
The person who entered the record on the system. The table below outlines requester and recorder combinations for clarity.
| Scenario | Requester | Recorder |
|---|---|---|
| Prescibing clinician Fred is requesting new medication | Fred | Fred |
| Prescibing clinician Fred is re-ordering previous medication he previously prescribed | Fred | Fred |
| Prescibing clinician Jane is re-ordering previous medication, without any clinical changes, that Fred previously prescribed | Fred | Jane |
| Prescibing clinician Jane is re-ordering previous medication that Fred previously prescribed, with clinical changes | Jane | Jane |
| Nurse Rodger is ordering medication prescribed by Fred | Fred | Rodger |
| Pharmacy technical Sally is re-ordering medication prescribed by Fred | Fred | Sally |
Example
<recorder> <identifier> <system value="https://fhir.hl7.org.uk/Id/gmc-number" /> <value value="0054272" /> </identifier> </recorder>
note
Usage
Required
Guidance
All notes that are associated with this medication/medical device record.
Sometimes labelled Pharmacy text or instructions for pharmacy.
Example
<note> <authorReference> <identifier> <system value="https://fhir.hl7.org.uk/Id/gmc-number" /> <value value="00143922" /> </identifier> </authorReference> <time value="2023-01-20T10:47:35.0536208+00:00" /> <text value="Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM)" /> </note>
dosageInstruction
Usage
Mandatory
Guidance
Complete dosage instructions as text.
Where the dosage instructions have been changed during the lifetime of the Medication/Medical Device plan append the following warning text to end of the dosage instructions:
WARNING – Dosage has changed during the effective period. The latest change was made on DD-Mmm-YYYY - where DD-Mmm-YYYY is the date the dosage was last changed.
In exceptional cases where for legacy data there is no dosage recorded in the system then this MUST be populated with the text: No information available.
The patientInstruction elemement MAY provide additional instructions to the patient, this is, RHS of the prescription label.
GP Connect providers may uplift to the Information Standards Notice outlined above at different times so please account for both textual and structured representations.
See Medication and Medical Device interoperability for additional information.
Example
Legacy (free text):
<dosageInstruction> <text value="2 tablet - every 4 hours - up to a maximum of 6 dose in 24 hours - when migraine recurs" /> <patientInstruction value="when migraine recurs" /> </dosageInstruction>
Structured dose syntax:
<dosageInstruction> <text value="2 tablet - every 4 hours - up to a maximum of 6 dose in 24 hours - when migraine recurs" /> <patientInstruction value="when migraine recurs" /> <timing> <repeat> <frequency value="1" /> <period value="4" /> <periodUnit value="h" /> </repeat> </timing> <doseQuantity> <value value="2" /> <unit value="tablet" /> <system value="http://snomed.info/sct" /> <code value="428673006" /> </doseQuantity> <maxDosePerPeriod> <numerator> <value value="6" /> <unit value="dose" /> <system value="http://snomed.info/sct" /> <code value="3317411000001100" /> </numerator> <denominator> <value value="24" /> <unit value="hour" /> <system value="http://unitsofmeasure.org/" /> <code value="h" /> </denominator> </maxDosePerPeriod> </dosageInstruction>
dispenseRequest.validityPeriod
Usage
Mandatory
Guidance
Prescription start and end dates.
Start date is mandatory. Where there is a defined expiry or end date the end date MUST be supplied.
For MedicationRequest instances where intent is set to plan:
- This refers to the period that the medication/medical device plan is active.
- This MUST mirror
MedicationStatement.effective
For MedicationRequest instances where intent is set to order:
- This refers to the period that the issued prescription is active
Period.start is MANDATORY
Use one of the following dates in order of descending preference:
- The prescription issue date recorded in the patient record
- The date the prescription was recorded.
Period.end is OPTIONAL
Use one of the following dates in order of descending preference:
- The prescription end date recorded in the patient record
- The prescription end date derived from
Period.startand the duration - The
Period.startdate -- This option should only occur where data has been lost (for example, during the record transfer between two systems) and is used to ensure that an ended prescription will always have an end date.
Example
<dispenseRequest> ... <validityPeriod> <start value="2023-01-20" /> <end value="2023-01-27" /> </validityPeriod> ... </dispenseRequest>
dispenseRequest.numberOfRepeatsAllowed
Usage
Optional
Guidance
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
Example
<numberOfRepeatsAllowed> <value value="7" /> </numberOfRepeatsAllowed>
dispenseRequest.quantity
Usage
Required
Guidance
The quantity to dispense.
When quantity to dispense is available as a numerical value dispenseRequest.quantity MUST be populated, in preference to dispenseRequest.quantityText.
Unit, system and code elements MUST be populated when information is available.
If quantity is a textual value, then the extension dispenseRequest.quantityText MUST be used for both value and units, leaving quantity element unpopulated.
When quantity to dispense is a textual value this field MUST contain both the value of the quantity to dispense and the unit e.g. ‘ten tablets’, ‘90 capsules’, ‘one dose’, ‘three millilitres’, ‘quantity varies dependent on schedule’. No information should be populated into dispenseRequest.quantity in this scenario.
Example
Fully coded
<dispenseRequest> ... <quantity> <value value="14" /> <unit value="capsule" /> <system value="http://snomed.info/sct" /> <code value="732937005" /> </quantity> ... </dispenseRequest>
Free text
<dispenseRequest> ... <quantity> <extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationQuantityText-1"> <valueString value="14 caspules" /> </extension> </quantity> ... </dispenseRequest>
dispenseRequest.expectedSupplyDuration
Usage
Required
Guidance
Number of days' supply per dispense.
Example
<dispenseRequest> ... <expectedSupplyDuration> <value value="7" /> <unit value="d" /> <system value="http://unitsofmeasure.org" /> <code value="d" /> </expectedSupplyDuration> ... </dispenseRequest>
dispenseRequest.performer
Usage
Required
Guidance
The organisation that dispensed the issue. This element can only be completed where the provider organisation knows explicitly which organisation dispensed the issue.
- It cannot be assumed to be the nominated pharmacy or appliance supplier
- Only populate for a medication request with an
intentwhich has the value oforder - This field should not be populated when a medication request has
intentwith the value ofplan
Example
<dispenseRequest> ... <performer> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="RFR" /> </identifier> </performer> ... </dispenseRequest>
priorPrescription
Usage
Optional
Guidance
References prior prescription authorisation.
May be used, for example, to reference prior authorisation where prescription is re-authorised or where amendments have been made. May reference the previous authorisation before the amendment.
The published FHIR specifications described this element is slightly different ways in different parts of the FHIR specification:
- A link to a resource representing an earlier order related order or prescription.
- An order or prescription that is being replaced.
The following guidance applies to each use case.
Linking to an earlier request
A medication request that is a re-supply medication request based on a previous request referenced within priorPrescription. This would allow both the ePMA and pharmacy systems to logically link requests and add verification checks to flag any differences to the user.
Linking to an order that is being replaced
The medication request being replaced will be referenced within priorPrescription. It would be expected that the referenced resource would be updated with a status of cancelled, entered-in-error or stopped.
This will allow both the ePMA and pharmacy systems to make it clear to the human user that one medication request replaces another.
Example
<priorPrescription> <reference value="medicationrequest-00578231" /> </priorPrescription>
eventHistory
Usage
Optional
Guidance
A use-case for this element within the GP Connect Data model has not yet been defined.
Example
<eventHistory> <reference value="provenance-001243" /> </eventHistory>
MedicationRequest elements not in use
The following elements MUST NOT be populated:
meta.versionId
meta.lastUpdated
definition
This is not in scope for this version of Care Connect and therefore not available for use in GP Connect.
category
This is not in scope for this version of Care Connect and therefore not available for use in GP Connect.
priority
This is not in scope for this version of Care Connect and therefore not available for use in GP Connect.
supportingInformation
This is not in scope for this version of Care Connect and therefore not available for use in GP Connect.
reasonCode
This information is available via linking to a Problem record.
reasonReference
This information is available via linking to a Problem record.
substitution
This is not in scope for this version of Care Connect and therefore not available for use in GP Connect.
detectedIssue
This is not in scope for this version of Care Connect and therefore not available for use in GP Connect.
eventHistory
This is not in scope for this version of Care Connect and therefore not available for use in GP Connect.