Finnish Base Profiles
0.2.0 - ci-build
Finnish Base Profiles - Local Development build (v0.2.0). See the Directory of published versions
Draft as of 2020-10-16 |
Definitions for the fiphr-sd-insulindosing-r4 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. MedicationAdministration | |
Definition | Finnish PHR profile describing the event of a patient consuming or otherwise being administered a medication. Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. |
2. MedicationAdministration.meta | |
Control | 10..1 |
3. MedicationAdministration.meta.profile | |
Control | 1..? |
Slicing | This element introduces a set of slices on MedicationAdministration.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. MedicationAdministration.meta.profile:fiphrProfile | |
SliceName | fiphrProfile |
Control | 1..1 |
Fixed Value | http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4 |
5. MedicationAdministration.language | |
Definition | The base language in which the resource is written. The base language in which the resource is written. |
Control | 10..1 |
Binding | A code of human language. A human language. |
Comments | FinnishPHR: codes from the code system urn:ietf:bcp:47 Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
6. MedicationAdministration.text | |
Control | 10..1 |
7. MedicationAdministration.extension | |
Slicing | This element introduces a set of slices on MedicationAdministration.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
8. MedicationAdministration.extension:creatingApplication | |
SliceName | creatingApplication |
Control | 0..? |
Type | Extension(FIPHREXTCreatingApplication) (Complex Extension) |
9. MedicationAdministration.identifier | |
Definition | A unique identifier assigned to the resource. Finnish PHR: At least one of the identifiers SHALL be globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
10. MedicationAdministration.identifier.use | |
Definition | The purpose of this identifier. Finnish PHR: The code 'official' SHALL be only used if the given identifier value is truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). |
Control | 0..? |
11. MedicationAdministration.identifier.system | |
Control | 1..? |
12. MedicationAdministration.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. Finnish PHR: At least one of the identifiers SHALL be truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). |
Control | 1..? |
13. MedicationAdministration.identifier.assigner | |
Control | 0..0 |
14. MedicationAdministration.instantiates | |
Control | 0..0* |
15. MedicationAdministration.partOf | |
Control | 0..0* |
16. MedicationAdministration.status | |
Definition | Will be set to show that the administration has been completed. Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way. |
Comments | FInnishPHR: Fixed value 'completed'. Only administrations that have been completed are supported in this profile. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Fixed Value | completed |
17. MedicationAdministration.statusReason | |
Control | 0..0* |
18. MedicationAdministration.category | |
Control | 0..01 |
19. MedicationAdministration.medication[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
20. MedicationAdministration.medication[x]:medicationCodeableConcept | |
SliceName | medicationCodeableConcept |
Definition | FinnishPHR: Identifies the medication that was administered (code and/or name). The coding of the medication SHALL be either (or both) the VNR code of the medication or a specific code indicating whether the administered insulin was intermediate or fast acting. |
Control | 0..? |
Binding | The codes SHALL be taken from Value Set Finnish PHR Insulin Code ; other codes may be used where these codes are not suitable Codes identifying substance or product administered |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | Finnish PHR: When the medication can be uniquely identified, the VNR code of the medication SHALL be given, and the brand name of the medication SHALL be given which SHALL match the name in the pharmaceutical database. A code indicating whether the administrated insulin was intermediate or fast acting may be given as well, and SHALL be given if a VNR code is unavailable. |
21. MedicationAdministration.medication[x]:medicationCodeableConcept.coding | |
Control | 1..? |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
22. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode | |
SliceName | VNRCode |
Definition | Finnish PHR: VNR code of the medication |
Control | 0..1 |
Comments | Finnish PHR: When the medication can be uniquely identified, the VNR code of the medication SHALL be given as well as the brand name of the medication which SHALL match the name in the pharmaceutical database. |
23. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.system | |
Definition | Finnish PHR: VNR code system |
Control | 1..? |
Fixed Value | urn:oid:1.2.246.537.6.55 |
24. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.code | |
Definition | Finnish PHR: VNR code defined by VNR code system |
Control | 1..? |
25. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.display | |
Control | 1..? |
26. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode | |
SliceName | insulinCode |
Definition | Finnish PHR: A code indicating whether the administered insulin was intermediate/long or fast acting. |
Control | 0..1 |
Comments | Finnish PHR: A code indicating whether the administered insulin was intermediate or fast acting may be given in addition to a VNR code, and SHALL be given if a VNR code is unavailable. |
27. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.system | |
Definition | Finnish PHR: Code system for insulin codes |
Control | 1..? |
Comments | . |
Fixed Value | http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode |
28. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.code | |
Definition | Finnish PHR: A code of the medication, indicating whether the administered insulin was intermediate/long or fast acting. |
Control | 1..? |
Comments | . |
29. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.display | |
Control | 1..? |
30. MedicationAdministration.medication[x]:medicationCodeableConcept.text | |
Control | 1..? |
31. MedicationAdministration.subject | |
Type | Reference(FIPHRSDPatient|Patient|Group) : {r} |
32. MedicationAdministration.subject.reference | |
Control | 1..? |
33. MedicationAdministration.context | |
Control | 0..01 |
34. MedicationAdministration.supportingInformation | |
Control | 0..0* |
35. MedicationAdministration.effective[x] | |
Definition | Finnish PHR: A specific time during which the administration took place. Boluses: use effectiveDateTime (and dosage.dose.value with no rate) Extended boluses: use effectivePeriod (and dosage.dose.value with no rate) Basal insulin records: use effectivePeriod (and dosage.rate to describe the amount of iU/hour being dosed as basal insulin) A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
[x] Note | See Choice of Data Types for further information about how to use [x] |
36. MedicationAdministration.performer | |
Control | 0..? |
37. MedicationAdministration.performer.actor | |
Type | Reference(FIPHRSDPatient|Practitioner|PractitionerRole|Patient|RelatedPerson|Device) : {r} |
38. MedicationAdministration.performer.actor.reference | |
Control | 1..? |
39. MedicationAdministration.reasonCode | |
Control | 0..0* |
40. MedicationAdministration.reasonReference | |
Control | 0..0* |
41. MedicationAdministration.request | |
Control | 0..01 |
42. MedicationAdministration.device | |
Control | 0..0* |
43. MedicationAdministration.note | |
Control | 0..? |
44. MedicationAdministration.note.author[x] | |
Control | 0..? |
Type | Choice of: Reference(FIPHRSDPatient) : {r}, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
45. MedicationAdministration.dosage | |
Control | 0..? |
46. MedicationAdministration.dosage.site | |
Control | 0..? |
47. MedicationAdministration.dosage.site.coding | |
Control | 1..? |
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.site.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
48. MedicationAdministration.dosage.site.coding:fiphrCoding | |
SliceName | fiphrCoding |
Control | 1..1 |
Binding | The codes SHALL be taken from http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite A value set for the site location the medicine enters into or onto the body (Reference to the national AR/Lääkitys - Lääkkeenantopaikka code system. |
49. MedicationAdministration.dosage.site.coding:fiphrCoding.system | |
Control | 1..? |
Fixed Value | urn:oid:1.2.246.537.5.163 |
50. MedicationAdministration.dosage.site.coding:fiphrCoding.code | |
Control | 1..? |
51. MedicationAdministration.dosage.site.coding:fiphrCoding.display | |
Control | 1..? |
52. MedicationAdministration.eventHistory | |
Control | 0..0* |
Guidance on how to interpret the contents of this table can be found here.
1. MedicationAdministration | |
Definition | Finnish PHR profile describing the event of a patient consuming or otherwise being administered a medication. Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. |
Control | 0..* |
Summary | false |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
2. MedicationAdministration.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 10..1 |
Type | Meta |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. MedicationAdministration.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 10..* |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationAdministration.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. MedicationAdministration.meta.profile:fiphrProfile | |
SliceName | fiphrProfile |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 10..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. |
Fixed Value | http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. MedicationAdministration.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. MedicationAdministration.language | |
Definition | The base language in which the resource is written. The base language in which the resource is written. |
Control | 10..1 |
Binding | The codes SHALL be taken from CommonLanguagesThe codes SHOULD be taken from CommonLanguages A code of human language. A human language. |
Type | code |
Summary | false |
Comments | FinnishPHR: codes from the code system urn:ietf:bcp:47 Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. MedicationAdministration.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 10..1 |
Type | Narrative |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. MedicationAdministration.extension | |
Definition | An Extension 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. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. MedicationAdministration.extension:creatingApplication | |
SliceName | creatingApplication |
Definition | Application identification information. SHALL have same values that has been registered for application in PHR application catalog. 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. |
Control | This element is affected by the following invariants: ele-1 |
Type | Extension(FIPHREXTCreatingApplication) (Complex Extension) |
Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
10. MedicationAdministration.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
11. MedicationAdministration.identifier | |
Definition | A unique identifier assigned to the resource. Finnish PHR: At least one of the identifiers SHALL be globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
Type | Identifier |
Summary | false |
Comments | This is a business identifier, not a resource identifier. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. MedicationAdministration.identifier.use | |
Definition | The purpose of this identifier. Finnish PHR: The code 'official' SHALL be only used if the given identifier value is truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). The purpose of this identifier. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. MedicationAdministration.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 10..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. |
Example | General:http://www.acme.com/identifiers/patient |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. MedicationAdministration.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. Finnish PHR: At least one of the identifiers SHALL be truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 10..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. |
Example | General:123456 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. MedicationAdministration.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..01 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. MedicationAdministration.instantiates | |
Definition | A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event. |
Control | 0..0* |
Type | uri |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. MedicationAdministration.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Control | 0..0* |
Type | Reference(MedicationAdministration|Procedure) |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. MedicationAdministration.status | |
Definition | Will be set to show that the administration has been completed. Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way. |
Control | 1..1 |
Binding | The codes SHALL be taken from MedicationAdministration Status Codes A set of codes indicating the current status of a MedicationAdministration. |
Type | code |
Is Modifier | true |
Summary | true |
Comments | FInnishPHR: Fixed value 'completed'. Only administrations that have been completed are supported in this profile. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Fixed Value | completed |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. MedicationAdministration.statusReason | |
Definition | A code indicating why the administration was not performed. |
Control | 0..0* |
Binding | For example codes, see SNOMEDCTReasonMedicationNotGivenCodes A set of codes indicating the reason why the MedicationAdministration is negated. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. MedicationAdministration.category | |
Definition | Indicates where the medication is expected to be consumed or administered. |
Control | 0..01 |
Binding | The codes SHOULD be taken from MedicationAdministration Category Codes A coded concept describing where the medication administered is expected to occur. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. MedicationAdministration.medication[x] | |
Definition | Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTMedicationCodes Codes identifying substance or product that can be administered. |
Type | Choice of: CodeableConcept, Reference(Medication) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
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, then you must reference the Medication resource. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
22. MedicationAdministration.medication[x]:medicationCodeableConcept | |
SliceName | medicationCodeableConcept |
Definition | FinnishPHR: Identifies the medication that was administered (code and/or name). The coding of the medication SHALL be either (or both) the VNR code of the medication or a specific code indicating whether the administered insulin was intermediate or fast acting. Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Control | 1..1 |
Binding | The codes SHALL be taken from Value Set Finnish PHR Insulin Code ; other codes may be used where these codes are not suitableFor example codes, see SNOMEDCTMedicationCodes Codes identifying substance or product administered. Codes identifying substance or product that can be administered. |
Type | Choice of: CodeableConcept, Reference(Medication) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | Finnish PHR: When the medication can be uniquely identified, the VNR code of the medication SHALL be given, and the brand name of the medication SHALL be given which SHALL match the name in the pharmaceutical database. A code indicating whether the administrated insulin was intermediate or fast acting may be given as well, and SHALL be given if a VNR code is unavailable. 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, then you must reference the Medication resource. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. MedicationAdministration.medication[x]:medicationCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 10..* |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
24. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode | |
SliceName | VNRCode |
Definition | Finnish PHR: VNR code of the medication A reference to a code defined by a terminology system. |
Control | 0..1* |
Type | Coding |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Finnish PHR: When the medication can be uniquely identified, the VNR code of the medication SHALL be given as well as the brand name of the medication which SHALL match the name in the pharmaceutical database. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.system | |
Definition | Finnish PHR: VNR code system The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..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. |
Fixed Value | urn:oid:1.2.246.537.6.55 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.code | |
Definition | Finnish PHR: VNR code defined by VNR code system A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 10..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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode | |
SliceName | insulinCode |
Definition | Finnish PHR: A code indicating whether the administered insulin was intermediate/long or fast acting. A reference to a code defined by a terminology system. |
Control | 0..1* |
Type | Coding |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Finnish PHR: A code indicating whether the administered insulin was intermediate or fast acting may be given in addition to a VNR code, and SHALL be given if a VNR code is unavailable. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.system | |
Definition | Finnish PHR: Code system for insulin codes The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..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. |
Fixed Value | http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.code | |
Definition | Finnish PHR: A code of the medication, indicating whether the administered insulin was intermediate/long or fast acting. A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 10..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | . |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 10..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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. MedicationAdministration.medication[x]:medicationCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 10..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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. MedicationAdministration.subject | |
Definition | The person or animal or group receiving the medication. |
Control | 1..1 |
Type | Reference(FIPHRSDPatient|Patient|Group) : {r} |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. MedicationAdministration.subject.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 10..1 This element is affected by the following invariants: ref-1 |
Type | string |
Summary | true |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. MedicationAdministration.context | |
Definition | The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. |
Control | 0..01 |
Type | Reference(Encounter|EpisodeOfCare) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. MedicationAdministration.supportingInformation | |
Definition | Additional information (for example, patient height and weight) that supports the administration of the medication. |
Control | 0..0* |
Type | Reference(Resource) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. MedicationAdministration.effective[x] | |
Definition | Finnish PHR: A specific time during which the administration took place. Boluses: use effectiveDateTime (and dosage.dose.value with no rate) Extended boluses: use effectivePeriod (and dosage.dose.value with no rate) Basal insulin records: use effectivePeriod (and dosage.rate to describe the amount of iU/hour being dosed as basal insulin) A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. |
Control | 1..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
38. MedicationAdministration.reasonCode | |
Definition | A code indicating why the medication was given. |
Control | 0..0* |
Binding | For example codes, see ReasonMedicationGivenCodes A set of codes indicating the reason why the MedicationAdministration was made. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. MedicationAdministration.reasonReference | |
Definition | Condition or observation that supports why the medication was administered. |
Control | 0..0* |
Type | Reference(Condition|Observation|DiagnosticReport) |
Summary | false |
Comments | This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. MedicationAdministration.request | |
Definition | The original request, instruction or authority to perform the administration. |
Control | 0..01 |
Type | Reference(MedicationRequest) |
Summary | false |
Comments | This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. MedicationAdministration.device | |
Definition | The device used in administering the medication to the patient. For example, a particular infusion pump. |
Control | 0..0* |
Type | Reference(Device) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. MedicationAdministration.eventHistory | |
Definition | A summary of the events of interest that have occurred, such as when the administration was verified. |
Control | 0..0* |
Type | Reference(Provenance) |
Summary | false |
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. MedicationAdministration | |
Definition | Finnish PHR profile describing the event of a patient consuming or otherwise being administered a medication. |
Control | 0..* |
Summary | false |
2. MedicationAdministration.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. |
3. MedicationAdministration.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 1..1 |
Type | Meta |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. MedicationAdministration.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
5. MedicationAdministration.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
6. MedicationAdministration.meta.versionId | |
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. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. MedicationAdministration.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. MedicationAdministration.meta.source | |
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. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. MedicationAdministration.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationAdministration.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
10. MedicationAdministration.meta.profile:fiphrProfile | |
SliceName | fiphrProfile |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 1..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. |
Fixed Value | http://phr.kanta.fi/StructureDefinition/fiphr-sd-insulindosing-r4 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. MedicationAdministration.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Control | 0..* |
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System |
Type | Coding |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. MedicationAdministration.meta.tag | |
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. |
Control | 0..* |
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
Type | Coding |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. MedicationAdministration.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. MedicationAdministration.language | |
Definition | The base language in which the resource is written. |
Control | 1..1 |
Binding | The codes SHALL be taken from CommonLanguages A code of human language |
Type | code |
Summary | false |
Comments | FinnishPHR: codes from the code system urn:ietf:bcp:47 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. MedicationAdministration.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 1..1 |
Type | Narrative |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. MedicationAdministration.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
17. MedicationAdministration.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. MedicationAdministration.extension:creatingApplication | |
SliceName | creatingApplication |
Definition | Application identification information. SHALL have same values that has been registered for application in PHR application catalog. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(FIPHREXTCreatingApplication) (Complex Extension) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
19. MedicationAdministration.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
20. MedicationAdministration.identifier | |
Definition | A unique identifier assigned to the resource. Finnish PHR: At least one of the identifiers SHALL be globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
Summary | false |
Comments | This is a business identifier, not a resource identifier. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. MedicationAdministration.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
22. MedicationAdministration.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
23. MedicationAdministration.identifier.use | |
Definition | The purpose of this identifier. Finnish PHR: The code 'official' SHALL be only used if the given identifier value is truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known |
Type | code |
Is 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. MedicationAdministration.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 |
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose |
Type | CodeableConcept |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. MedicationAdministration.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 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. |
Example | General:http://www.acme.com/identifiers/patient |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. MedicationAdministration.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. Finnish PHR: At least one of the identifiers SHALL be truly globally unique (e.g. an uuid as the value and 'urn:ietf:rfc:3986' as the system). |
Control | 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. |
Example | General:123456 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. MedicationAdministration.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. MedicationAdministration.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..0 |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. MedicationAdministration.instantiates | |
Definition | A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event. |
Control | 0..0 |
Type | uri |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. MedicationAdministration.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Control | 0..0 |
Type | Reference(MedicationAdministration|Procedure) |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. MedicationAdministration.status | |
Definition | Will be set to show that the administration has been completed. |
Control | 1..1 |
Binding | The codes SHALL be taken from MedicationAdministration Status Codes A set of codes indicating the current status of a MedicationAdministration |
Type | code |
Is Modifier | true |
Summary | true |
Comments | FInnishPHR: Fixed value 'completed'. Only administrations that have been completed are supported in this profile. |
Fixed Value | completed |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. MedicationAdministration.statusReason | |
Definition | A code indicating why the administration was not performed. |
Control | 0..0 |
Binding | For example codes, see SNOMEDCTReasonMedicationNotGivenCodes A set of codes indicating the reason why the MedicationAdministration is negated |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
33. MedicationAdministration.category | |
Definition | Indicates where the medication is expected to be consumed or administered. |
Control | 0..0 |
Binding | The codes SHOULD be taken from MedicationAdministration Category Codes A coded concept describing where the medication administered is expected to occur |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. MedicationAdministration.medication[x] | |
Definition | Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Control | 1..1 |
Binding | For example codes, see SNOMEDCTMedicationCodes Codes identifying substance or product that can be administered |
Type | Choice of: CodeableConcept, Reference(Medication) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
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, then you must reference the Medication resource. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
35. MedicationAdministration.medication[x]:medicationCodeableConcept | |
SliceName | medicationCodeableConcept |
Definition | FinnishPHR: Identifies the medication that was administered (code and/or name). The coding of the medication SHALL be either (or both) the VNR code of the medication or a specific code indicating whether the administered insulin was intermediate or fast acting. |
Control | 1..1 |
Binding | The codes SHALL be taken from Value Set Finnish PHR Insulin Code ; other codes may be used where these codes are not suitable Codes identifying substance or product administered |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | Finnish PHR: When the medication can be uniquely identified, the VNR code of the medication SHALL be given, and the brand name of the medication SHALL be given which SHALL match the name in the pharmaceutical database. A code indicating whether the administrated insulin was intermediate or fast acting may be given as well, and SHALL be given if a VNR code is unavailable. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. MedicationAdministration.medication[x]:medicationCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
37. MedicationAdministration.medication[x]:medicationCodeableConcept.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
38. MedicationAdministration.medication[x]:medicationCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
39. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode | |
SliceName | VNRCode |
Definition | Finnish PHR: VNR code of the medication |
Control | 0..1 |
Type | Coding |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Finnish PHR: When the medication can be uniquely identified, the VNR code of the medication SHALL be given as well as the brand name of the medication which SHALL match the name in the pharmaceutical database. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
41. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
42. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.system | |
Definition | Finnish PHR: VNR code system |
Control | 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. |
Fixed Value | urn:oid:1.2.246.537.6.55 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
43. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
44. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.code | |
Definition | Finnish PHR: VNR code defined by VNR code system |
Control | 1..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
45. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
46. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:VNRCode.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
47. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode | |
SliceName | insulinCode |
Definition | Finnish PHR: A code indicating whether the administered insulin was intermediate/long or fast acting. |
Control | 0..1 |
Type | Coding |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Finnish PHR: A code indicating whether the administered insulin was intermediate or fast acting may be given in addition to a VNR code, and SHALL be given if a VNR code is unavailable. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
48. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
49. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.medication[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
50. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.system | |
Definition | Finnish PHR: Code system for insulin codes |
Control | 1..1 |
Type | uri |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | . |
Fixed Value | http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
51. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
52. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.code | |
Definition | Finnish PHR: A code of the medication, indicating whether the administered insulin was intermediate/long or fast acting. |
Control | 1..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Comments | . |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
53. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
54. MedicationAdministration.medication[x]:medicationCodeableConcept.coding:insulinCode.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
55. MedicationAdministration.medication[x]:medicationCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 1..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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
56. MedicationAdministration.subject | |
Definition | The person or animal or group receiving the medication. |
Control | 1..1 |
Type | Reference(FIPHRSDPatient) : {r} |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
57. MedicationAdministration.subject.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
58. MedicationAdministration.subject.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
59. MedicationAdministration.subject.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Summary | true |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
60. MedicationAdministration.subject.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Control | 0..1 |
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) |
Type | uri |
Summary | true |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
61. MedicationAdministration.subject.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Summary | true |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
62. MedicationAdministration.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
63. MedicationAdministration.context | |
Definition | The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. |
Control | 0..0 |
Type | Reference(Encounter|EpisodeOfCare) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
64. MedicationAdministration.supportingInformation | |
Definition | Additional information (for example, patient height and weight) that supports the administration of the medication. |
Control | 0..0 |
Type | Reference(Resource) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
65. MedicationAdministration.effective[x] | |
Definition | Finnish PHR: A specific time during which the administration took place. Boluses: use effectiveDateTime (and dosage.dose.value with no rate) Extended boluses: use effectivePeriod (and dosage.dose.value with no rate) Basal insulin records: use effectivePeriod (and dosage.rate to describe the amount of iU/hour being dosed as basal insulin) |
Control | 1..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
66. MedicationAdministration.performer | |
Definition | Indicates who or what performed the medication administration and how they were involved. |
Control | 0..* |
Type | BackboneElement |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
67. MedicationAdministration.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
68. MedicationAdministration.performer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
69. MedicationAdministration.performer.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
70. MedicationAdministration.performer.function | |
Definition | Distinguishes the type of involvement of the performer in the medication administration. |
Control | 0..1 |
Binding | For example codes, see MedicationAdministration Performer Function Codes A code describing the role an individual played in administering the medication |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
71. MedicationAdministration.performer.actor | |
Definition | Indicates who or what performed the medication administration. |
Control | 1..1 |
Type | Reference(FIPHRSDPatient) : {r} |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
72. MedicationAdministration.performer.actor.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
73. MedicationAdministration.performer.actor.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.performer.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
74. MedicationAdministration.performer.actor.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Summary | true |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
75. MedicationAdministration.performer.actor.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Control | 0..1 |
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) |
Type | uri |
Summary | true |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
76. MedicationAdministration.performer.actor.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Summary | true |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
77. MedicationAdministration.performer.actor.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
78. MedicationAdministration.reasonCode | |
Definition | A code indicating why the medication was given. |
Control | 0..0 |
Binding | For example codes, see ReasonMedicationGivenCodes A set of codes indicating the reason why the MedicationAdministration was made |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
79. MedicationAdministration.reasonReference | |
Definition | Condition or observation that supports why the medication was administered. |
Control | 0..0 |
Type | Reference(Condition|Observation|DiagnosticReport) |
Summary | false |
Comments | This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
80. MedicationAdministration.request | |
Definition | The original request, instruction or authority to perform the administration. |
Control | 0..0 |
Type | Reference(MedicationRequest) |
Summary | false |
Comments | This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
81. MedicationAdministration.device | |
Definition | The device used in administering the medication to the patient. For example, a particular infusion pump. |
Control | 0..0 |
Type | Reference(Device) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
82. MedicationAdministration.note | |
Definition | Extra information about the medication administration that is not conveyed by the other attributes. |
Control | 0..* |
Type | Annotation |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
83. MedicationAdministration.note.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
84. MedicationAdministration.note.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
85. MedicationAdministration.note.author[x] | |
Definition | The individual responsible for making the annotation. |
Control | 0..1 |
Type | Choice of: Reference(FIPHRSDPatient) : {r}, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
86. MedicationAdministration.note.time | |
Definition | Indicates when this particular annotation was made. |
Control | 0..1 |
Type | dateTime |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
87. MedicationAdministration.note.text | |
Definition | The text of the annotation in markdown format. |
Control | 1..1 |
Type | markdown |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
88. MedicationAdministration.dosage | |
Definition | Describes the medication dosage information details e.g. dose, rate, site, route, etc. |
Control | 0..1 |
Type | BackboneElement |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] (: dose.exists() or rate.exists()) |
89. MedicationAdministration.dosage.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
90. MedicationAdministration.dosage.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
91. MedicationAdministration.dosage.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
92. MedicationAdministration.dosage.text | |
Definition | Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered. |
Control | 0..1 |
Type | string |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
93. MedicationAdministration.dosage.site | |
Definition | A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTAnatomicalStructureForAdministrationSiteCodes A coded concept describing the site location the medicine enters into or onto the body |
Type | CodeableConcept |
Summary | false |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
94. MedicationAdministration.dosage.site.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
95. MedicationAdministration.dosage.site.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.site.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
96. MedicationAdministration.dosage.site.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.site.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
97. MedicationAdministration.dosage.site.coding:fiphrCoding | |
SliceName | fiphrCoding |
Definition | A reference to a code defined by a terminology system. |
Control | 1..1 |
Binding | The codes SHALL be taken from http://phr.kanta.fi/ValueSet/fiphr-vs-dosagesite A value set for the site location the medicine enters into or onto the body (Reference to the national AR/Lääkitys - Lääkkeenantopaikka code system. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
98. MedicationAdministration.dosage.site.coding:fiphrCoding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
99. MedicationAdministration.dosage.site.coding:fiphrCoding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MedicationAdministration.dosage.site.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
100. MedicationAdministration.dosage.site.coding:fiphrCoding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 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. |
Fixed Value | urn:oid:1.2.246.537.5.163 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
101. MedicationAdministration.dosage.site.coding:fiphrCoding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
102. MedicationAdministration.dosage.site.coding:fiphrCoding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
103. MedicationAdministration.dosage.site.coding:fiphrCoding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
104. MedicationAdministration.dosage.site.coding:fiphrCoding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
105. MedicationAdministration.dosage.site.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
106. MedicationAdministration.dosage.route | |
Definition | A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTRouteCodes A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
107. MedicationAdministration.dosage.method | |
Definition | A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTAdministrationMethodCodes A coded concept describing the technique by which the medicine is administered |
Type | CodeableConcept |
Summary | false |
Comments | One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
108. MedicationAdministration.dosage.dose | |
Definition | The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Summary | false |
Comments | If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
109. MedicationAdministration.dosage.rate[x] | |
Definition | 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. |
Control | 0..1 |
Type | Choice of: Ratio, Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Comments | If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
110. MedicationAdministration.eventHistory | |
Definition | A summary of the events of interest that have occurred, such as when the administration was verified. |
Control | 0..0 |
Type | Reference(Provenance) |
Summary | false |
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |