MedicationRequest
CareConnect-MedicationRequest-1 (MedicationRequest) | C | MedicationRequest | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
repeatInformation | C | 0..1 | Extension(Complex) |
statusReason | C | 0..1 | Extension(Complex) |
prescriptionType | C | 0..1 | Extension(CodeableConcept) |
modifierExtension | ?! | 0..* | Extension |
identifier | 0..* | Identifier | |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) |
basedOn | Σ | 0..* | Reference(CarePlan | ProcedureRequest | ReferralRequest | ) |
groupIdentifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
status | Σ ?! | 0..1 | codeBinding |
intent | Σ ?! | 1..1 | codeBinding |
category | 0..1 | CodeableConceptBinding | |
priority | Σ | 0..1 | codeBinding |
medication[x] | Σ | 1..1 | |
medicationCodeableConcept | CodeableConcept | ||
medicationReference | Reference() | ||
subject | Σ | 1..1 | Reference(Group | ) |
context | 0..1 | Reference(EpisodeOfCare | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) | |
supportingInformation | 0..* | Reference(Resource) | |
authoredOn | Σ | 0..1 | dateTime |
requester | Σ C | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
agent | Σ | 1..1 | Reference(RelatedPerson | Device | | | ) |
onBehalfOf | Σ C | 0..1 | Reference() |
recorder | 0..1 | Reference() | |
reasonCode | 0..* | CodeableConcept | |
reasonReference | 0..* | Reference( | ) | |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(RelatedPerson | | ) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
dosageInstruction | 0..* | Dosage | |
id | 0..1 | string | |
extension | 0..* | Extension | |
sequence | Σ | 0..1 | integer |
text | Σ | 0..1 | string |
additionalInstruction | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
patientInstruction | Σ | 0..1 | string |
timing | Σ | 0..1 | Timing |
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
site | Σ | 0..1 | CodeableConcept |
route | Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | CodingBinding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
method | Σ | 0..1 | CodeableConcept |
dose[x] | Σ | 0..1 | |
doseRange | Range | ||
doseQuantity | SimpleQuantity | ||
maxDosePerPeriod | Σ | 0..1 | Ratio |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity |
rate[x] | Σ | 0..1 | |
rateRatio | Ratio | ||
rateRange | Range | ||
rateQuantity | SimpleQuantity | ||
dispenseRequest | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
validityPeriod | 0..1 | Period | |
numberOfRepeatsAllowed | 0..1 | positiveInt | |
quantity | 0..1 | SimpleQuantity | |
id | 0..1 | string | |
extension | 0..* | Extension | |
quantityText | C | 0..1 | Extension(string) |
value | Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ C | 0..1 | uri |
code | Σ | 0..1 | code |
expectedSupplyDuration | 0..1 | Duration | |
id | 0..1 | string | |
extension | 0..* | Extension | |
value | Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ C | 1..1 | uriFixed Value |
code | Σ | 1..1 | codeBinding |
performer | 0..1 | Reference() | |
substitution | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
allowed | ?! | 1..1 | boolean |
reason | 0..1 | CodeableConcept | |
priorPrescription | 0..1 | Reference() | |
detectedIssue | 0..* | Reference(DetectedIssue) | |
eventHistory | 0..* | Reference(Provenance) |
MedicationRequest | |||
Short | Ordering of medication for patient or group | ||
Definition | An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. | ||
Cardinality | 0..* | ||
Alias | Prescription, Order | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
MedicationRequest.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
MedicationRequest.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
MedicationRequest.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
MedicationRequest.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
MedicationRequest.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
MedicationRequest.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
MedicationRequest.extension:repeatInformation | |||
Short | Medication repeat information | ||
Definition | Medication repeat information. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.extension:statusReason | |||
Short | To record the reason the medication (plan or order) was stopped and the date this occurred | ||
Definition | To record the reason the medication (plan or order) was stopped and the date this occurred. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.extension:prescriptionType | |||
Short | To record the type of prescription | ||
Definition | To record the type of prescription. | ||
Cardinality | 0..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationRequest.identifier | |||
Short | External ids for this request | ||
Definition | This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Mappings |
| ||
MedicationRequest.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
MedicationRequest.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
MedicationRequest.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
MedicationRequest.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
MedicationRequest.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
MedicationRequest.definition | |||
Short | Protocol or definition | ||
Definition | Protocol or definition followed by this request. | ||
Cardinality | 0..* | ||
Type | Reference(ActivityDefinition | PlanDefinition) | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.basedOn | |||
Short | What request fulfills | ||
Definition | A plan or request that is fulfilled in whole or in part by this medication request. | ||
Cardinality | 0..* | ||
Type | Reference(CarePlan | ProcedureRequest | ReferralRequest | ) | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.groupIdentifier | |||
Short | Composite request this is part of | ||
Definition | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. | ||
Cardinality | 0..1 | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.groupIdentifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
MedicationRequest.status | |||
Short | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown | ||
Definition | A code specifying the current state of the order. Generally this will be active or completed state. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Mappings |
| ||
MedicationRequest.intent | |||
Short | proposal | plan | order | instance-order | ||
Definition | Whether the request is a proposal, plan, or an original order. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The kind of medication order | ||
Modifier | True | ||
Summary | True | ||
Comments | It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only. An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. | ||
Mappings |
| ||
MedicationRequest.category | |||
Short | Type of medication usage | ||
Definition | Indicates the type of medication order and where the medication is expected to be consumed or administered. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept identifying where the medication ordered is expected to be consumed or administered | ||
Mappings |
| ||
MedicationRequest.priority | |||
Short | routine | urgent | stat | asap | ||
Definition | Indicates how quickly the Medication Request should be addressed with respect to other requests. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the level of importance to be assigned to actioning the request | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.medication[x] | |||
Short | Medication to be taken | ||
Definition | Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. | ||
Cardinality | 1..1 | ||
Type | Reference(), CodeableConcept | ||
Binding | A coded concept identifying substance or product that can be ordered. | ||
Summary | True | ||
Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource. . | ||
Mappings |
| ||
MedicationRequest.subject | |||
Short | Who or group medication request is for | ||
Definition | A link to a resource representing the person or set of individuals to whom the medication will be given. | ||
Cardinality | 1..1 | ||
Type | Reference(Group | ) | ||
Summary | True | ||
Comments | The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified. | ||
Mappings |
| ||
MedicationRequest.context | |||
Short | Created during encounter/admission/stay | ||
Definition | A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider. | ||
Cardinality | 0..1 | ||
Type | Reference(EpisodeOfCare | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) | ||
Comments | SubstanceAdministration->component->EncounterEvent. | ||
Mappings |
| ||
MedicationRequest.supportingInformation | |||
Short | Information to support ordering of the medication | ||
Definition | Include additional information (for example, patient height and weight) that supports the ordering of the medication. | ||
Cardinality | 0..* | ||
Type | Reference(Resource) | ||
Mappings |
| ||
MedicationRequest.authoredOn | |||
Short | When request was initially authored | ||
Definition | The date (and perhaps time) when the prescription was initially written or authored on. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.requester | |||
Short | Who/What requested the Request | ||
Definition | The individual, organization or device that initiated the request and has responsibility for its activation. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.requester.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.requester.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationRequest.requester.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
MedicationRequest.requester.agent | |||
Short | Who ordered the initial medication(s) | ||
Definition | The healthcare professional responsible for authorizing the initial prescription. | ||
Cardinality | 1..1 | ||
Type | Reference(RelatedPerson | Device | | | ) | ||
Summary | True | ||
Comments | It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only. | ||
Mappings |
| ||
MedicationRequest.requester.onBehalfOf | |||
Short | Organization agent is acting for | ||
Definition | The organization the device or practitioner was acting on behalf of. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Summary | True | ||
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: mps-1 | ||
Mappings |
| ||
MedicationRequest.recorder | |||
Short | Person who entered the request | ||
Definition | The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
MedicationRequest.reasonCode | |||
Short | Reason or indication for writing the prescription | ||
Definition | The reason or the indication for ordering the medication. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A coded concept indicating why the medication was ordered. | ||
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference. | ||
Mappings |
| ||
MedicationRequest.reasonReference | |||
Short | Condition or Observation that supports why the prescription is being written | ||
Definition | Condition or observation that supports why the medication was ordered. | ||
Cardinality | 0..* | ||
Type | Reference( | ) | ||
Comments | This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode. | ||
Mappings |
| ||
MedicationRequest.note | |||
Short | Information about the prescription | ||
Definition | Extra information about the prescription that could not be conveyed by the other attributes. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Mappings |
| ||
MedicationRequest.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.note.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference(RelatedPerson | | ), string | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dosageInstruction | |||
Short | How the medication should be taken | ||
Definition | Indicates how the medication is to be used by the patient. | ||
Cardinality | 0..* | ||
Type | Dosage | ||
Comments | There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.sequence | |||
Short | The order of the dosage instructions | ||
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. | ||
Cardinality | 0..1 | ||
Type | integer | ||
Summary | True | ||
Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.text | |||
Short | Free text dosage instructions e.g. SIG | ||
Definition | Free text dosage instructions e.g. SIG. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction | |||
Short | Supplemental instruction - e.g. "with meals" | ||
Definition | Supplemental instruction - e.g. "with meals". | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||
Summary | True | ||
Requirements | Additional instruction such as "Swallow with plenty of water" which may or may not be coded. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||
Fixed Value | http://snomed.info/sct | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.additionalInstruction.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.patientInstruction | |||
Short | Patient or consumer oriented instructions | ||
Definition | Instructions in terms that are understood by the patient or consumer. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.timing | |||
Short | When medication should be administered | ||
Definition | When medication should be administered. | ||
Cardinality | 0..1 | ||
Type | Timing | ||
Summary | True | ||
Requirements | The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||
Comments | This attribute may not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.asNeeded[x] | |||
Short | Take "as needed" (for x) | ||
Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | ||
Cardinality | 0..1 | ||
Type | boolean, CodeableConcept | ||
Binding | A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||
Summary | True | ||
Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.site | |||
Short | Body site to administer to | ||
Definition | Body site to administer to. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the site location the medicine enters into or onto the body. SNOMED CT Anatomical Structure for Administration Site Codes (example) | ||
Summary | True | ||
Requirements | A coded specification of the anatomic site where the medication first enters the body. | ||
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route | |||
Short | How drug should enter body | ||
Definition | How drug should enter body. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||
Summary | True | ||
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||
Fixed Value | http://snomed.info/sct | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.route.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.method | |||
Short | Technique for administering medication | ||
Definition | Technique for administering medication. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the technique by which the medicine is administered. | ||
Summary | True | ||
Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. | ||
Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.dose[x] | |||
Short | Amount of medication per dose | ||
Definition | Amount of medication per dose. | ||
Cardinality | 0..1 | ||
Type | Range, SimpleQuantity | ||
Summary | True | ||
Requirements | The amount of therapeutic or other substance given at one administration event. | ||
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.maxDosePerPeriod | |||
Short | Upper limit on medication per unit of time | ||
Definition | Upper limit on medication per unit of time. | ||
Cardinality | 0..1 | ||
Type | Ratio | ||
Summary | True | ||
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. | ||
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.maxDosePerAdministration | |||
Short | Upper limit on medication per administration | ||
Definition | Upper limit on medication per administration. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Summary | True | ||
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. | ||
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.maxDosePerLifetime | |||
Short | Upper limit on medication per lifetime of the patient | ||
Definition | Upper limit on medication per lifetime of the patient. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Summary | True | ||
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. | ||
Mappings |
| ||
MedicationRequest.dosageInstruction.rate[x] | |||
Short | Amount of medication per unit of time | ||
Definition | Amount of medication per unit of time. | ||
Cardinality | 0..1 | ||
Type | Ratio, Range, SimpleQuantity | ||
Summary | True | ||
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest | |||
Short | Medication supply authorization | ||
Definition | Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.dispenseRequest.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.validityPeriod | |||
Short | Time period supply is authorized for | ||
Definition | This indicates the validity period of a prescription (stale dating the Prescription). | ||
Cardinality | 0..1 | ||
Type | Period | ||
Requirements | Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription. | ||
Comments | It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.numberOfRepeatsAllowed | |||
Short | Number of refills authorized | ||
Definition | An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. | ||
Cardinality | 0..1 | ||
Type | positiveInt | ||
Comments | If displaying "number of authorized fills", add 1 to this number. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity | |||
Short | Amount of medication to supply per dispense | ||
Definition | The amount that is to be dispensed for one fill. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.extension:quantityText | |||
Short | Quantity representation | ||
Definition | Quantity representation. | ||
Cardinality | 0..1 | ||
Type | Extension(string) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.value | |||
Short | Numerical value (with implicit precision) | ||
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||
Cardinality | 0..1 | ||
Type | decimal | ||
Summary | True | ||
Requirements | Precision is handled implicitly in almost all cases of measurement. | ||
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.comparator | |||
Short | < | <= | >= | > - how to understand the value | ||
Definition | Not allowed to be used in this context | ||
Cardinality | 0..0 | ||
Type | code | ||
Binding | How the Quantity should be understood and represented. | ||
Modifier | True | ||
Summary | True | ||
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. | ||
Meaning when missing | If there is no comparator, then there is no modification of the value | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.unit | |||
Short | Unit representation | ||
Definition | A human-readable form of the unit. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.system | |||
Short | System that defines coded unit form | ||
Definition | The identification of the system that provides the coded form of the unit. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to know the system that defines the coded form of the unit. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: qty-3 | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.quantity.code | |||
Short | Coded form of the unit | ||
Definition | A computer processable form of the unit in some unit representation system. | ||
Cardinality | 0..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration | |||
Short | Number of days supply per dispense | ||
Definition | Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. | ||
Cardinality | 0..1 | ||
Type | Duration | ||
Comments | In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration.value | |||
Short | Numerical value (with implicit precision) | ||
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||
Cardinality | 1..1 | ||
Type | decimal | ||
Summary | True | ||
Requirements | Precision is handled implicitly in almost all cases of measurement. | ||
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration.comparator | |||
Short | < | <= | >= | > - how to understand the value | ||
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | How the Quantity should be understood and represented. | ||
Modifier | True | ||
Summary | True | ||
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. | ||
Meaning when missing | If there is no comparator, then there is no modification of the value | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration.unit | |||
Short | Unit representation | ||
Definition | A human-readable form of the unit. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration.system | |||
Short | System that defines coded unit form | ||
Definition | The identification of the system that provides the coded form of the unit. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to know the system that defines the coded form of the unit. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: qty-3 | ||
Fixed Value | http://unitsofmeasure.org | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.expectedSupplyDuration.code | |||
Short | Coded form of the unit | ||
Definition | A computer processable form of the unit in some unit representation system. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | A unit of time (units from UCUM). | ||
Summary | True | ||
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||
Mappings |
| ||
MedicationRequest.dispenseRequest.performer | |||
Short | Intended dispenser | ||
Definition | Indicates the intended dispensing Organization specified by the prescriber. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
MedicationRequest.substitution | |||
Short | Any restrictions on medication substitution | ||
Definition | Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
MedicationRequest.substitution.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationRequest.substitution.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationRequest.substitution.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
MedicationRequest.substitution.allowed | |||
Short | Whether substitution is allowed or not | ||
Definition | True if the prescriber allows a different drug to be dispensed from what was prescribed. | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Modifier | True | ||
Comments | This element is labeled as a modifer because whether substitution is allow or not cannot be ignored. | ||
Mappings |
| ||
MedicationRequest.substitution.reason | |||
Short | Why should (not) substitution be made | ||
Definition | Indicates the reason for the substitution, or why substitution must or must not be performed. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | ||
Mappings |
| ||
MedicationRequest.priorPrescription | |||
Short | An order/prescription that is being replaced | ||
Definition | A link to a resource representing an earlier order related order or prescription. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
MedicationRequest.detectedIssue | |||
Short | Clinical Issue with action | ||
Definition | Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. | ||
Cardinality | 0..* | ||
Type | Reference(DetectedIssue) | ||
Alias | Contraindication, Drug Utilization Review (DUR), Alert | ||
Mappings |
| ||
MedicationRequest.eventHistory | |||
Short | A list of events of interest in the lifecycle | ||
Definition | Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. | ||
Cardinality | 0..* | ||
Type | Reference(Provenance) | ||
Comments | This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.). | ||
Mappings |
|
MedicationDispense
CareConnect-MedicationDispense-1 (MedicationDispense) | C | MedicationDispense | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
modifierExtension | ?! | 0..* | Extension |
identifier | 0..* | Identifier | |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
partOf | 0..* | Reference() | |
status | Σ ?! | 0..1 | codeBinding |
category | 0..1 | CodeableConceptBinding | |
medication[x] | Σ | 1..1 | |
medicationCodeableConcept | CodeableConcept | ||
medicationReference | Reference() | ||
subject | Σ | 0..1 | Reference(Group | ) |
context | 0..1 | Reference( | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) | |
supportingInformation | 0..* | Reference(Resource) | |
performer | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
actor | 1..1 | Reference(Device | | | | ) | |
onBehalfOf | 0..1 | Reference() | |
authorizingPrescription | 0..* | Reference() | |
type | 0..1 | CodeableConceptBinding | |
quantity | 0..1 | SimpleQuantity | |
id | 0..1 | string | |
extension | 0..* | Extension | |
quantityText | C | 0..1 | Extension(string) |
value | Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ C | 0..1 | uri |
code | Σ | 0..1 | code |
daysSupply | 0..1 | SimpleQuantity | |
whenPrepared | Σ | 0..1 | dateTime |
whenHandedOver | 0..1 | dateTime | |
destination | 0..1 | Reference() | |
receiver | 0..* | Reference( | ) | |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference( | | ) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
dosageInstruction | 0..* | Dosage | |
substitution | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
wasSubstituted | 1..1 | boolean | |
type | 0..1 | CodeableConcept | |
reason | 0..* | CodeableConcept | |
responsibleParty | 0..* | Reference() | |
detectedIssue | 0..* | Reference(DetectedIssue) | |
notDone | 0..1 | boolean | |
notDoneReason[x] | 0..1 | ||
notDoneReasonCodeableConcept | CodeableConcept | ||
notDoneReasonReference | Reference(DetectedIssue) | ||
eventHistory | 0..* | Reference(Provenance) |
MedicationDispense | |||
Short | Dispensing a medication to a named patient | ||
Definition | Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order. | ||
Cardinality | 0..* | ||
Comments | The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html). | ||
Constraints |
| ||
Mappings |
| ||
MedicationDispense.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
MedicationDispense.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
MedicationDispense.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
MedicationDispense.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
MedicationDispense.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
MedicationDispense.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
MedicationDispense.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationDispense.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationDispense.identifier | |||
Short | External identifier | ||
Definition | Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Mappings |
| ||
MedicationDispense.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationDispense.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationDispense.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
MedicationDispense.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
MedicationDispense.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
MedicationDispense.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
MedicationDispense.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
MedicationDispense.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
MedicationDispense.partOf | |||
Short | Event that dispense is part of | ||
Definition | The procedure that the dispense is done because of. | ||
Cardinality | 0..* | ||
Type | Reference() | ||
Mappings |
| ||
MedicationDispense.status | |||
Short | preparation | in-progress | on-hold | completed | entered-in-error | stopped | ||
Definition | A code specifying the state of the set of dispense events. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A coded concept specifying the state of the dispense event. | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Mappings |
| ||
MedicationDispense.category | |||
Short | Type of medication dispense | ||
Definition | Indicates type of medication dispense and where the medication is expected to be consumed or administered. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A code describing where the dispensed medication is expected to be consumed or administered | ||
Mappings |
| ||
MedicationDispense.medication[x] | |||
Short | What medication was supplied | ||
Definition | Identifies the medication being 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. | ||
Cardinality | 1..1 | ||
Type | Reference(), CodeableConcept | ||
Binding | A coded concept identifying which substance or product can be dispensed | ||
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. . | ||
Mappings |
| ||
MedicationDispense.subject | |||
Short | Who the dispense is for | ||
Definition | A link to a resource representing the person or the group to whom the medication will be given. | ||
Cardinality | 0..1 | ||
Type | Reference(Group | ) | ||
Summary | True | ||
Comments | SubstanceAdministration->subject->Patient. | ||
Mappings |
| ||
MedicationDispense.context | |||
Short | Encounter / Episode associated with event | ||
Definition | The encounter or episode of care that establishes the context for this event. | ||
Cardinality | 0..1 | ||
Type | Reference( | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) | ||
Mappings |
| ||
MedicationDispense.supportingInformation | |||
Short | Information that supports the dispensing of the medication | ||
Definition | Additional information that supports the medication being dispensed. | ||
Cardinality | 0..* | ||
Type | Reference(Resource) | ||
Mappings |
| ||
MedicationDispense.performer | |||
Short | Who performed event | ||
Definition | Indicates who or what performed the event. It should be assumed that the performer is the dispenser of the medication. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Comments | The performer will be reviewed as part of STU4. | ||
Constraints |
| ||
Mappings |
| ||
MedicationDispense.performer.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationDispense.performer.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationDispense.performer.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
MedicationDispense.performer.actor | |||
Short | Individual who was performing | ||
Definition | The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. | ||
Cardinality | 1..1 | ||
Type | Reference(Device | | | | ) | ||
Mappings |
| ||
MedicationDispense.performer.onBehalfOf | |||
Short | Organization organization was acting for | ||
Definition | The organization the device or practitioner was acting on behalf of. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
MedicationDispense.authorizingPrescription | |||
Short | Medication order that authorizes the dispense | ||
Definition | Indicates the medication order that is being dispensed against. | ||
Cardinality | 0..* | ||
Type | Reference() | ||
Comments | Maps to basedOn in Event logical model. | ||
Mappings |
| ||
MedicationDispense.type | |||
Short | To identify the type of medication supply. | ||
Definition | Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A ValueSet to identify the type of medication supply. | ||
Mappings |
| ||
MedicationDispense.quantity | |||
Short | Amount dispensed | ||
Definition | The amount of medication that has been dispensed. Includes unit of measure. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Mappings |
| ||
MedicationDispense.quantity.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationDispense.quantity.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationDispense.quantity.extension:quantityText | |||
Short | Quantity representation | ||
Definition | Quantity representation. | ||
Cardinality | 0..1 | ||
Type | Extension(string) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationDispense.quantity.value | |||
Short | Numerical value (with implicit precision) | ||
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||
Cardinality | 0..1 | ||
Type | decimal | ||
Summary | True | ||
Requirements | Precision is handled implicitly in almost all cases of measurement. | ||
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||
Mappings |
| ||
MedicationDispense.quantity.comparator | |||
Short | < | <= | >= | > - how to understand the value | ||
Definition | Not allowed to be used in this context | ||
Cardinality | 0..0 | ||
Type | code | ||
Binding | How the Quantity should be understood and represented. | ||
Modifier | True | ||
Summary | True | ||
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. | ||
Meaning when missing | If there is no comparator, then there is no modification of the value | ||
Mappings |
| ||
MedicationDispense.quantity.unit | |||
Short | Unit representation | ||
Definition | A human-readable form of the unit. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||
Mappings |
| ||
MedicationDispense.quantity.system | |||
Short | System that defines coded unit form | ||
Definition | The identification of the system that provides the coded form of the unit. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to know the system that defines the coded form of the unit. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: qty-3 | ||
Mappings |
| ||
MedicationDispense.quantity.code | |||
Short | Coded form of the unit | ||
Definition | A computer processable form of the unit in some unit representation system. | ||
Cardinality | 0..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||
Mappings |
| ||
MedicationDispense.daysSupply | |||
Short | Amount of medication expressed as a timing amount | ||
Definition | The amount of medication expressed as a timing amount. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Mappings |
| ||
MedicationDispense.whenPrepared | |||
Short | When product was packaged and reviewed | ||
Definition | The time when the dispensed product was packaged and reviewed. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
MedicationDispense.whenHandedOver | |||
Short | When product was given out | ||
Definition | The time the dispensed product was provided to the patient or their representative. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Mappings |
| ||
MedicationDispense.destination | |||
Short | Where the medication was sent | ||
Definition | Identification of the facility/location where the medication was shipped to, as part of the dispense event. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
MedicationDispense.receiver | |||
Short | Who collected the medication | ||
Definition | Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. | ||
Cardinality | 0..* | ||
Type | Reference( | ) | ||
Mappings |
| ||
MedicationDispense.note | |||
Short | Information about the dispense | ||
Definition | Extra information about the dispense that could not be conveyed in the other attributes. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Mappings |
| ||
MedicationDispense.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationDispense.note.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationDispense.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference( | | ), string | ||
Summary | True | ||
Mappings |
| ||
MedicationDispense.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
MedicationDispense.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
MedicationDispense.dosageInstruction | |||
Short | How the medication is to be used by the patient or administered by the caregiver | ||
Definition | Indicates how the medication is to be used by the patient. | ||
Cardinality | 0..* | ||
Type | Dosage | ||
Comments | When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed. | ||
Mappings |
| ||
MedicationDispense.substitution | |||
Short | Whether a substitution was performed on the dispense | ||
Definition | Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
MedicationDispense.substitution.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationDispense.substitution.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationDispense.substitution.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
MedicationDispense.substitution.wasSubstituted | |||
Short | Whether a substitution was or was not performed on the dispense | ||
Definition | True if the dispenser dispensed a different drug or product from what was prescribed. | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Mappings |
| ||
MedicationDispense.substitution.type | |||
Short | Code signifying whether a different drug was dispensed from what was prescribed | ||
Definition | A code signifying whether a different drug was dispensed from what was prescribed. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription | ||
Mappings |
| ||
MedicationDispense.substitution.reason | |||
Short | Why was substitution made | ||
Definition | Indicates the reason for the substitution of (or lack of substitution) from what was prescribed. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed | ||
Mappings |
| ||
MedicationDispense.substitution.responsibleParty | |||
Short | Who is responsible for the substitution | ||
Definition | The person or organization that has primary responsibility for the substitution. | ||
Cardinality | 0..* | ||
Type | Reference() | ||
Mappings |
| ||
MedicationDispense.detectedIssue | |||
Short | Clinical issue with action | ||
Definition | Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. | ||
Cardinality | 0..* | ||
Type | Reference(DetectedIssue) | ||
Alias | Contraindication, Drug Utilization Review (DUR), Alert | ||
Mappings |
| ||
MedicationDispense.notDone | |||
Short | Whether the dispense was or was not performed | ||
Definition | True if the dispense was not performed for some reason. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Mappings |
| ||
MedicationDispense.notDoneReason[x] | |||
Short | Why a dispense was not performed | ||
Definition | Indicates the reason why a dispense was not performed. | ||
Cardinality | 0..1 | ||
Type | Reference(DetectedIssue), CodeableConcept | ||
Mappings |
| ||
MedicationDispense.eventHistory | |||
Short | A list of releveant lifecycle events | ||
Definition | A summary of the events of interest that have occurred, such as when the dispense was verified. | ||
Cardinality | 0..* | ||
Type | Reference(Provenance) | ||
Comments | This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.). | ||
Mappings |
|
MedicationStatement
CareConnect-MedicationStatement-1 (MedicationStatement) | C | MedicationStatement | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
lastIssueDate | C | 0..1 | Extension(dateTime) |
changeSummary | C | 0..1 | Extension(Complex) |
dosageLastChanged | C | 0..1 | Extension(dateTime) |
prescribingAgency | C | 0..1 | Extension(CodeableConcept) |
modifierExtension | ?! | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
basedOn | Σ | 0..* | Reference(CarePlan | ProcedureRequest | ReferralRequest | ) |
partOf | Σ | 0..* | Reference(MedicationAdministration | | | | ) |
context | Σ | 0..1 | Reference(EpisodeOfCare | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) |
status | Σ ?! | 1..1 | codeBinding |
category | Σ | 0..1 | CodeableConceptBinding |
medication[x] | Σ | 1..1 | |
medicationCodeableConcept | CodeableConcept | ||
medicationReference | Reference() | ||
effective[x] | Σ | 0..1 | |
effectiveDateTime | dateTime | ||
effectivePeriod | Period | ||
dateAsserted | Σ | 0..1 | dateTime |
informationSource | 0..1 | Reference(RelatedPerson | | | ) | |
subject | Σ | 1..1 | Reference(Group | ) |
derivedFrom | 0..* | Reference(Resource) | |
taken | Σ ?! | 1..1 | codeBinding |
reasonNotTaken | C | 0..* | CodeableConcept |
reasonCode | 0..* | CodeableConcept | |
reasonReference | 0..* | Reference( | ) | |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(RelatedPerson | | ) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
dosage | 0..* | Dosage | |
id | 0..1 | string | |
extension | 0..* | Extension | |
sequence | Σ | 0..1 | integer |
text | Σ | 0..1 | string |
additionalInstruction | Σ | 0..* | CodeableConcept |
patientInstruction | Σ | 0..1 | string |
timing | Σ | 0..1 | Timing |
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
site | Σ | 0..1 | CodeableConcept |
route | Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
method | Σ | 0..1 | CodeableConcept |
dose[x] | Σ | 0..1 | |
doseRange | Range | ||
doseQuantity | SimpleQuantity | ||
maxDosePerPeriod | Σ | 0..1 | Ratio |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity |
rate[x] | Σ | 0..1 | |
rateRatio | Ratio | ||
rateRange | Range | ||
rateQuantity | SimpleQuantity |
MedicationStatement | |||
Short | Record of medication being taken by a patient | ||
Definition | A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. | ||
Cardinality | 0..* | ||
Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. | ||
Constraints |
| ||
Mappings |
| ||
MedicationStatement.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
MedicationStatement.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
MedicationStatement.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
MedicationStatement.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
MedicationStatement.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
MedicationStatement.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
MedicationStatement.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
MedicationStatement.extension:lastIssueDate | |||
Short | The date a prescription was last issued | ||
Definition | The date a prescription was last issued. | ||
Cardinality | 0..1 | ||
Type | Extension(dateTime) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationStatement.extension:changeSummary | |||
Short | Optional Extensions Element | ||
Definition | Optional Extension Element - found in all resources. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationStatement.extension:dosageLastChanged | |||
Short | The date when the dosage instructions were last changed | ||
Definition | Only populate where the dosage instructions have been changed during the lifetime of the Medication/Medical Device plan. Set to the date when the dosage instructions were last changed. | ||
Cardinality | 0..1 | ||
Type | Extension(dateTime) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationStatement.extension:prescribingAgency | |||
Short | The type of organisation/setting responsible for authorising and issuing a medication outside of the organisation/setting delivering the patient care | ||
Definition | The type of organisation/setting responsible for authorising and issuing a medication outside of the organisation/setting delivering the patient care. | ||
Cardinality | 0..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationStatement.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationStatement.identifier | |||
Short | External identifier | ||
Definition | External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationStatement.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationStatement.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
MedicationStatement.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
MedicationStatement.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
MedicationStatement.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
MedicationStatement.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
MedicationStatement.basedOn | |||
Short | Fulfils plan, proposal or order | ||
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. | ||
Cardinality | 0..* | ||
Type | Reference(CarePlan | ProcedureRequest | ReferralRequest | ) | ||
Summary | True | ||
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | ||
Mappings |
| ||
MedicationStatement.partOf | |||
Short | Part of referenced event | ||
Definition | A larger event of which this particular event is a component or step. | ||
Cardinality | 0..* | ||
Type | Reference(MedicationAdministration | | | | ) | ||
Summary | True | ||
Requirements | This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. | ||
Mappings |
| ||
MedicationStatement.context | |||
Short | Encounter / Episode associated with MedicationStatement | ||
Definition | The encounter or episode of care that establishes the context for this MedicationStatement. | ||
Cardinality | 0..1 | ||
Type | Reference(EpisodeOfCare | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.status | |||
Short | active | completed | entered-in-error | intended | stopped | on-hold | ||
Definition | A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | A coded concept indicating the current status of a MedicationStatement. | ||
Modifier | True | ||
Summary | True | ||
Comments | MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Mappings |
| ||
MedicationStatement.category | |||
Short | Type of medication usage | ||
Definition | Indicates where type of medication statement and where the medication is expected to be consumed or administered. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept identifying where the medication included in the medicationstatement is expected to be consumed or administered | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.medication[x] | |||
Short | What medication was taken | ||
Definition | Identifies the medication being 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. | ||
Cardinality | 1..1 | ||
Type | Reference(), CodeableConcept | ||
Binding | A coded concept identifying the substance or product being taken. | ||
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. . | ||
Mappings |
| ||
MedicationStatement.effective[x] | |||
Short | The date/time or interval when the medication was taken | ||
Definition | The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true). | ||
Cardinality | 0..1 | ||
Type | dateTime, Period | ||
Summary | True | ||
Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. | ||
Mappings |
| ||
MedicationStatement.dateAsserted | |||
Short | When the statement was asserted? | ||
Definition | The date when the medication statement was asserted by the information source. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.informationSource | |||
Short | Person or organization that provided the information about the taking of this medication | ||
Definition | The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g Claim or MedicationRequest. | ||
Cardinality | 0..1 | ||
Type | Reference(RelatedPerson | | | ) | ||
Mappings |
| ||
MedicationStatement.subject | |||
Short | Who is/was taking the medication | ||
Definition | The person, animal or group who is/was taking the medication. | ||
Cardinality | 1..1 | ||
Type | Reference(Group | ) | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.derivedFrom | |||
Short | Additional supporting information | ||
Definition | Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. | ||
Cardinality | 0..* | ||
Type | Reference(Resource) | ||
Comments | Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from. | ||
Mappings |
| ||
MedicationStatement.taken | |||
Short | y | n | unk | na | ||
Definition | Indicator of the certainty of whether the medication was taken by the patient. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | A coded concept identifying level of certainty if patient has taken or has not taken the medication | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because it indicates that the medication was not taken. | ||
Mappings |
| ||
MedicationStatement.reasonNotTaken | |||
Short | True if asserting medication was not given | ||
Definition | A code indicating why the medication was not taken. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A coded concept indicating the reason why the medication was not taken | ||
Conditions | The cardinality or value of this element may be affected by these constraints: mst-1 | ||
Mappings |
| ||
MedicationStatement.reasonCode | |||
Short | Reason for why the medication is being/was taken | ||
Definition | A reason for why the medication is being/was taken. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A coded concept identifying why the medication is being taken. | ||
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. | ||
Mappings |
| ||
MedicationStatement.reasonReference | |||
Short | Condition or observation that supports why the medication is being/was taken | ||
Definition | Condition or observation that supports why the medication is being/was taken. | ||
Cardinality | 0..* | ||
Type | Reference( | ) | ||
Comments | This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode. | ||
Mappings |
| ||
MedicationStatement.note | |||
Short | Further information about the statement | ||
Definition | Provides extra information about the medication statement that is not conveyed by the other attributes. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Mappings |
| ||
MedicationStatement.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationStatement.note.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationStatement.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference(RelatedPerson | | ), string | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
MedicationStatement.dosage | |||
Short | Details of how medication is/was taken or should be taken | ||
Definition | Indicates how the medication is/was or should be taken by the patient. | ||
Cardinality | 0..* | ||
Type | Dosage | ||
Comments | The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest. | ||
Mappings |
| ||
MedicationStatement.dosage.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationStatement.dosage.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationStatement.dosage.sequence | |||
Short | The order of the dosage instructions | ||
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. | ||
Cardinality | 0..1 | ||
Type | integer | ||
Summary | True | ||
Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. | ||
Mappings |
| ||
MedicationStatement.dosage.text | |||
Short | Free text dosage instructions e.g. SIG | ||
Definition | Free text dosage instructions e.g. SIG. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. | ||
Mappings |
| ||
MedicationStatement.dosage.additionalInstruction | |||
Short | Supplemental instruction - e.g. "with meals" | ||
Definition | Supplemental instruction - e.g. "with meals". | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||
Summary | True | ||
Requirements | Additional instruction such as "Swallow with plenty of water" which may or may not be coded. | ||
Mappings |
| ||
MedicationStatement.dosage.patientInstruction | |||
Short | Patient or consumer oriented instructions | ||
Definition | Instructions in terms that are understood by the patient or consumer. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Mappings |
| ||
MedicationStatement.dosage.timing | |||
Short | When medication should be administered | ||
Definition | When medication should be administered. | ||
Cardinality | 0..1 | ||
Type | Timing | ||
Summary | True | ||
Requirements | The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||
Comments | This attribute may not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. | ||
Mappings |
| ||
MedicationStatement.dosage.asNeeded[x] | |||
Short | Take "as needed" (for x) | ||
Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | ||
Cardinality | 0..1 | ||
Type | boolean, CodeableConcept | ||
Binding | A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||
Summary | True | ||
Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | ||
Mappings |
| ||
MedicationStatement.dosage.site | |||
Short | Body site to administer to | ||
Definition | Body site to administer to. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the site location the medicine enters into or onto the body. SNOMED CT Anatomical Structure for Administration Site Codes (example) | ||
Summary | True | ||
Requirements | A coded specification of the anatomic site where the medication first enters the body. | ||
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both. | ||
Mappings |
| ||
MedicationStatement.dosage.route | |||
Short | How drug should enter body | ||
Definition | How drug should enter body. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||
Summary | True | ||
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. | ||
Mappings |
| ||
MedicationStatement.dosage.route.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationStatement.dosage.route.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. (example) | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||
Fixed Value | http://snomed.info/sct | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
MedicationStatement.dosage.route.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
MedicationStatement.dosage.route.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
MedicationStatement.dosage.method | |||
Short | Technique for administering medication | ||
Definition | Technique for administering medication. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the technique by which the medicine is administered. | ||
Summary | True | ||
Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. | ||
Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. | ||
Mappings |
| ||
MedicationStatement.dosage.dose[x] | |||
Short | Amount of medication per dose | ||
Definition | Amount of medication per dose. | ||
Cardinality | 0..1 | ||
Type | Range, SimpleQuantity | ||
Summary | True | ||
Requirements | The amount of therapeutic or other substance given at one administration event. | ||
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. | ||
Mappings |
| ||
MedicationStatement.dosage.maxDosePerPeriod | |||
Short | Upper limit on medication per unit of time | ||
Definition | Upper limit on medication per unit of time. | ||
Cardinality | 0..1 | ||
Type | Ratio | ||
Summary | True | ||
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. | ||
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". | ||
Mappings |
| ||
MedicationStatement.dosage.maxDosePerAdministration | |||
Short | Upper limit on medication per administration | ||
Definition | Upper limit on medication per administration. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Summary | True | ||
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. | ||
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. | ||
Mappings |
| ||
MedicationStatement.dosage.maxDosePerLifetime | |||
Short | Upper limit on medication per lifetime of the patient | ||
Definition | Upper limit on medication per lifetime of the patient. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Summary | True | ||
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. | ||
Mappings |
| ||
MedicationStatement.dosage.rate[x] | |||
Short | Amount of medication per unit of time | ||
Definition | Amount of medication per unit of time. | ||
Cardinality | 0..1 | ||
Type | Ratio, Range, SimpleQuantity | ||
Summary | True | ||
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. | ||
Mappings |
|
MedicationAdministration
CareConnect-MedicationAdministration-1 (MedicationAdministration) | C | MedicationAdministration | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
modifierExtension | ?! | 0..* | Extension |
identifier | 0..* | Identifier | |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition) |
partOf | Σ | 0..* | Reference( | ) |
status | Σ ?! | 1..1 | codeBinding |
category | 0..1 | CodeableConceptBinding | |
medication[x] | Σ | 1..1 | |
medicationCodeableConcept | CodeableConcept | ||
medicationReference | Reference() | ||
subject | Σ | 1..1 | Reference(Group | ) |
context | 0..1 | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1 | ) | |
supportingInformation | 0..* | Reference(Resource) | |
effective[x] | Σ | 1..1 | |
effectiveDateTime | dateTime | ||
effectivePeriod | Period | ||
performer | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
actor | Σ | 1..1 | Reference(Device | | | ) |
onBehalfOf | 0..1 | Reference() | |
notGiven | Σ ?! | 0..1 | boolean |
reasonNotGiven | C | 0..* | CodeableConcept |
reasonCode | C | 0..* | CodeableConcept |
reasonReference | 0..* | Reference( | ) | |
prescription | 0..1 | Reference() | |
device | 0..* | Reference(Device) | |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference( | | ) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
dosage | C | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
text | 0..1 | string | |
site | 0..1 | CodeableConcept | |
route | 0..1 | CodeableConcept | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
SnomedCTDescriptionId | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
method | 0..1 | CodeableConcept | |
dose | 0..1 | SimpleQuantity | |
rate[x] | 0..1 | ||
rateRatio | Ratio | ||
rateQuantity | SimpleQuantity | ||
eventHistory | 0..* | Reference(Provenance) |
MedicationAdministration | |||
Short | Administration of medication to a patient | ||
Definition | 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. | ||
Cardinality | 0..* | ||
Comments | The WG will be updating the MedicationAdministration resource to adjust each affected resource to align with the workflow pattern (see workflow.html). | ||
Constraints |
| ||
Mappings |
| ||
MedicationAdministration.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
MedicationAdministration.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
MedicationAdministration.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
MedicationAdministration.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
MedicationAdministration.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
MedicationAdministration.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
MedicationAdministration.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationAdministration.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationAdministration.identifier | |||
Short | External identifier | ||
Definition | External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Mappings |
| ||
MedicationAdministration.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationAdministration.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
MedicationAdministration.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
MedicationAdministration.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
MedicationAdministration.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
MedicationAdministration.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
MedicationAdministration.definition | |||
Short | Instantiates protocol or definition | ||
Definition | A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event. | ||
Cardinality | 0..* | ||
Type | Reference(PlanDefinition | ActivityDefinition) | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.partOf | |||
Short | Part of referenced event | ||
Definition | A larger event of which this particular event is a component or step. | ||
Cardinality | 0..* | ||
Type | Reference( | ) | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.status | |||
Short | in-progress | on-hold | completed | entered-in-error | stopped | unknown | ||
Definition | 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. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | A set of codes indicating the current status of a MedicationAdministration. | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Mappings |
| ||
MedicationAdministration.category | |||
Short | Type of medication usage | ||
Definition | Indicates the type of medication administration and where the medication is expected to be consumed or administered. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing where the medication administered is expected to occur | ||
Mappings |
| ||
MedicationAdministration.medication[x] | |||
Short | What was administered | ||
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. | ||
Cardinality | 1..1 | ||
Type | Reference(), CodeableConcept | ||
Binding | Codes identifying substance or product that can be administered. | ||
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. . | ||
Mappings |
| ||
MedicationAdministration.subject | |||
Short | Who received medication | ||
Definition | The person or animal or group receiving the medication. | ||
Cardinality | 1..1 | ||
Type | Reference(Group | ) | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.context | |||
Short | Encounter or Episode of Care administered as part of | ||
Definition | The visit, admission or other contact between patient and health care provider the medication administration was performed as part of. | ||
Cardinality | 0..1 | ||
Type | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1 | ) | ||
Mappings |
| ||
MedicationAdministration.supportingInformation | |||
Short | Additional information to support administration | ||
Definition | Additional information (for example, patient height and weight) that supports the administration of the medication. | ||
Cardinality | 0..* | ||
Type | Reference(Resource) | ||
Mappings |
| ||
MedicationAdministration.effective[x] | |||
Short | Start and end time of administration | ||
Definition | 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. | ||
Cardinality | 1..1 | ||
Type | dateTime, Period | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.performer | |||
Short | Who administered substance | ||
Definition | The individual who was responsible for giving the medication to the patient. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
MedicationAdministration.performer.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.performer.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationAdministration.performer.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
MedicationAdministration.performer.actor | |||
Short | Individual who was performing | ||
Definition | The device, practitioner, etc. who performed the action. | ||
Cardinality | 1..1 | ||
Type | Reference(Device | | | ) | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.performer.onBehalfOf | |||
Short | Organization organization was acting for | ||
Definition | The organization the device or practitioner was acting on behalf of. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
MedicationAdministration.notGiven | |||
Short | True if medication not administered | ||
Definition | Set this to true if the record is saying that the medication was NOT administered. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because it indicates that a administration didn't happen. | ||
Meaning when missing | If this is missing, then the medication was administered | ||
Mappings |
| ||
MedicationAdministration.reasonNotGiven | |||
Short | Reason administration not performed | ||
Definition | A code indicating why the administration was not performed. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A set of codes indicating the reason why the MedicationAdministration is negated. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: mad-2 | ||
Mappings |
| ||
MedicationAdministration.reasonCode | |||
Short | Reason administration performed | ||
Definition | A code indicating why the medication was given. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A set of codes indicating the reason why the MedicationAdministration was made. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: mad-3 | ||
Mappings |
| ||
MedicationAdministration.reasonReference | |||
Short | Condition or Observation that supports why the medication was administered | ||
Definition | Condition or observation that supports why the medication was administered. | ||
Cardinality | 0..* | ||
Type | Reference( | ) | ||
Comments | This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode. | ||
Mappings |
| ||
MedicationAdministration.prescription | |||
Short | Request administration performed against | ||
Definition | The original request, instruction or authority to perform the administration. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
MedicationAdministration.device | |||
Short | Device used to administer | ||
Definition | The device used in administering the medication to the patient. For example, a particular infusion pump. | ||
Cardinality | 0..* | ||
Type | Reference(Device) | ||
Mappings |
| ||
MedicationAdministration.note | |||
Short | Information about the administration | ||
Definition | Extra information about the medication administration that is not conveyed by the other attributes. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Mappings |
| ||
MedicationAdministration.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.note.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationAdministration.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference( | | ), string | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
MedicationAdministration.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.dosage | |||
Short | Details of how medication was taken | ||
Definition | Describes the medication dosage information details e.g. dose, rate, site, route, etc. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
MedicationAdministration.dosage.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.dosage.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
MedicationAdministration.dosage.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
MedicationAdministration.dosage.text | |||
Short | Free text dosage instructions e.g. SIG | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.dosage.site | |||
Short | Body site administered to | ||
Definition | A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the site location the medicine enters into or onto the body. SNOMED CT Anatomical Structure for Administration Site Codes (example) | ||
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both. | ||
Mappings |
| ||
MedicationAdministration.dosage.route | |||
Short | Path of substance into body | ||
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. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||
Mappings |
| ||
MedicationAdministration.dosage.route.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.dosage.route.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. (example) | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.extension:SnomedCTDescriptionId | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||
Fixed Value | http://snomed.info/sct | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
MedicationAdministration.dosage.route.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
MedicationAdministration.dosage.route.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
MedicationAdministration.dosage.method | |||
Short | How drug was administered | ||
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. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept describing the technique by which the medicine is administered. | ||
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. | ||
Mappings |
| ||
MedicationAdministration.dosage.dose | |||
Short | Amount of medication per 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. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
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. | ||
Mappings |
| ||
MedicationAdministration.dosage.rate[x] | |||
Short | Dose quantity per unit of time | ||
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. | ||
Cardinality | 0..1 | ||
Type | Ratio, SimpleQuantity | ||
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. | ||
Mappings |
| ||
MedicationAdministration.eventHistory | |||
Short | A list of events of interest in the lifecycle | ||
Definition | A summary of the events of interest that have occurred, such as when the administration was verified. | ||
Cardinality | 0..* | ||
Type | Reference(Provenance) | ||
Comments | This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. | ||
Mappings |
|
Medication
CareConnect-Medication-1 (Medication) | C | Medication | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
modifierExtension | ?! | 0..* | Extension |
code | Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
status | Σ | 0..1 | codeBinding |
isBrand | Σ | 0..1 | boolean |
isOverTheCounter | Σ | 0..1 | boolean |
manufacturer | Σ | 0..1 | Reference() |
form | 0..1 | CodeableConceptBinding | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
ingredient | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
item[x] | 1..1 | ||
itemCodeableConcept | CodeableConcept | ||
itemReference | Reference(Substance | ) | ||
isActive | 0..1 | boolean | |
amount | 0..1 | Ratio | |
package | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
container | 0..1 | CodeableConcept | |
content | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
item[x] | 1..1 | ||
itemCodeableConcept | CodeableConcept | ||
itemReference | Reference() | ||
amount | 0..1 | SimpleQuantity | |
batch | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime | |
image | 0..* | Attachment |
Medication | |||
Short | Definition of a Medication | ||
Definition | This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
Medication.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
Medication.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
Medication.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
Medication.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
Medication.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
Medication.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
Medication.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Medication.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Medication.code | |||
Short | Codes that identify this medication | ||
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes a medication from the VTM/VMP/VMPP/AMP/AMPP subsets from the dm+d terminology (required) | ||
Summary | True | ||
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. | ||
Mappings |
| ||
Medication.code.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.code.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Medication.code.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
Medication.code.coding.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.code.coding.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Medication.code.coding.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Medication.code.coding.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 0..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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Mappings |
| ||
Medication.code.coding.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
Medication.code.coding.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 0..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
Medication.code.coding.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
Medication.code.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
Medication.code.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
Medication.status | |||
Short | active | inactive | entered-in-error | ||
Definition | A code to indicate if the medication is in active use. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A coded concept defining if the medication is in active use | ||
Summary | True | ||
Comments | This status is not intended to specify if a medication is part of a formulary. | ||
Mappings |
| ||
Medication.isBrand | |||
Short | True if a brand | ||
Definition | Set to true if the item is attributable to a specific manufacturer. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Mappings |
| ||
Medication.isOverTheCounter | |||
Short | True if medication does not require a prescription | ||
Definition | Set to true if the medication can be obtained without an order from a prescriber. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Mappings |
| ||
Medication.manufacturer | |||
Short | Manufacturer of the item | ||
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Summary | True | ||
Mappings |
| ||
Medication.form | |||
Short | Codes that describe a medication dose form | ||
Definition | Describes the form of the item. Powder; tablets; capsule. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form (required) | ||
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. | ||
Mappings |
| ||
Medication.form.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.form.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Medication.form.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
Medication.form.coding.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.form.coding.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Medication.form.coding.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Medication.form.coding.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||
Fixed Value | http://snomed.info/sct | ||
Mappings |
| ||
Medication.form.coding.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
Medication.form.coding.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
Medication.form.coding.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
Medication.form.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
Medication.form.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
Medication.ingredient | |||
Short | Active or inactive ingredient | ||
Definition | Identifies a particular constituent of interest in the product. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. | ||
Constraints |
| ||
Mappings |
| ||
Medication.ingredient.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.ingredient.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Medication.ingredient.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Medication.ingredient.item[x] | |||
Short | The product contained | ||
Definition | The actual ingredient - either a substance (simple ingredient) or another medication. | ||
Cardinality | 1..1 | ||
Type | Reference(Substance | ), CodeableConcept | ||
Mappings |
| ||
Medication.ingredient.isActive | |||
Short | Active ingredient indicator | ||
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). | ||
Mappings |
| ||
Medication.ingredient.amount | |||
Short | Quantity of ingredient present | ||
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. | ||
Cardinality | 0..1 | ||
Type | Ratio | ||
Mappings |
| ||
Medication.package | |||
Short | Details about packaged medications | ||
Definition | Information that only applies to packages (not products). | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Medication.package.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.package.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Medication.package.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Medication.package.container | |||
Short | E.g. box, vial, blister-pack | ||
Definition | The kind of container that this package comes as. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded concept defining the kind of container a medication package is packaged in | ||
Mappings |
| ||
Medication.package.content | |||
Short | What is in the package | ||
Definition | A set of components that go to make up the described item. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Medication.package.content.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.package.content.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Medication.package.content.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Medication.package.content.item[x] | |||
Short | The item in the package | ||
Definition | Identifies one of the items in the package. | ||
Cardinality | 1..1 | ||
Type | Reference(), CodeableConcept | ||
Mappings |
| ||
Medication.package.content.amount | |||
Short | Quantity present in the package | ||
Definition | The amount of the product that is in the package. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Mappings |
| ||
Medication.package.batch | |||
Short | Identifies a single production run | ||
Definition | Information about a group of medication produced or packaged from one production run. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Medication.package.batch.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.package.batch.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Medication.package.batch.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Medication.package.batch.lotNumber | |||
Short | Identifier assigned to batch | ||
Definition | The assigned lot number of a batch of the specified product. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Medication.package.batch.expirationDate | |||
Short | When batch will expire | ||
Definition | When this specific batch of product will expire. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Mappings |
| ||
Medication.image | |||
Short | Picture of the medication | ||
Definition | Photo(s) or graphic representation(s) of the medication. | ||
Cardinality | 0..* | ||
Type | Attachment | ||
Requirements | Note that "image" is only applicable when the medication.code represents a physical item (e.g. Amoxil 250 mg capsule) and not an abstract item (e.g. amoxicillin 250 mg). | ||
Mappings |
|
Patient
CareConnect-Patient-1 (Patient) | C | Patient | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
ethnicCategory | C | 0..1 | Extension(CodeableConcept) |
religiousAffiliation | C | 0..1 | Extension(CodeableConcept) |
patient-cadavericDonor | C | 0..1 | Extension(boolean) |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueBoolean | 0..1 | boolean | |
residentialStatus | C | 0..1 | Extension(CodeableConcept) |
treatmentCategory | C | 0..1 | Extension(CodeableConcept) |
nhsCommunication | C | 0..* | Extension(Complex) |
id | 0..1 | string | |
extension | 1..* | Extension | |
language | 1..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueCodeableConcept | 1..1 | CodeableConceptBinding | |
preferred | 0..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueBoolean | 1..1 | boolean | |
modeOfCommunication | 0..* | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueCodeableConcept | 1..1 | CodeableConceptBinding | |
communicationProficiency | 0..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueCodeableConcept | 1..1 | CodeableConceptBinding | |
interpreterRequired | 0..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueBoolean | 1..1 | boolean | |
url | 1..1 | uriFixed Value | |
value[x] | 0..0 | ||
birthPlace | C | 0..1 | Extension(Address) |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueAddress | 0..1 | Address | |
nominatedPharmacy | C | 0..1 | Extension(Reference()) |
deathNotificationStatus | C | 0..1 | Extension(Complex) |
modifierExtension | ?! | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
nhsNumber | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | 1..* | Extension | |
nhsNumberVerificationStatus | C | 1..1 | Extension(CodeableConcept) |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
active | Σ ?! | 0..1 | boolean |
name | Σ | 0..* | HumanName |
official | Σ | 1..1 | HumanName |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 1..1 | codeBindingFixed Value |
text | Σ | 0..1 | string |
family | Σ | 1..1 | string |
given | Σ | 0..* | string |
prefix | Σ | 0..* | string |
suffix | Σ | 0..* | string |
period | Σ | 0..1 | Period |
telecom | Σ | 0..* | ContactPoint |
id | 0..1 | string | |
extension | 0..* | Extension | |
system | Σ C | 1..1 | codeBinding |
value | Σ | 1..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | Σ | 0..1 | Period |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
id | 0..1 | string | |
extension | 0..* | Extension | |
patient-birthTime | C | 0..1 | Extension(dateTime) |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueDateTime | 0..1 | dateTime | |
value | 0..1 | ||
deceased[x] | Σ ?! | 0..1 | |
deceasedBoolean | boolean | ||
deceasedDateTime | dateTime | ||
address | Σ | 0..* | Address |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | string |
country | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
maritalStatus | 0..1 | CodeableConceptBinding | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
multipleBirth[x] | 0..1 | ||
multipleBirthBoolean | boolean | ||
multipleBirthInteger | integer | ||
photo | 0..* | Attachment | |
contact | C | 0..* | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
relationship | 0..* | CodeableConceptBinding | |
name | 1..1 | HumanName | |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 1..1 | codeBinding |
text | Σ | 0..1 | string |
family | Σ | 0..1 | string |
given | Σ | 0..* | string |
prefix | Σ | 0..* | string |
suffix | Σ | 0..* | string |
period | Σ | 0..1 | Period |
telecom | 0..* | ContactPoint | |
address | 0..1 | Address | |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | string |
country | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
gender | 0..1 | codeBinding | |
organization | C | 0..1 | Reference() |
period | 0..1 | Period | |
animal | Σ ?! | 0..0 | BackboneElement |
communication | 0..0 | BackboneElement | |
generalPractitioner | 0..* | Reference( | ) | |
managingOrganization | Σ | 0..1 | Reference() |
link | Σ ?! | 0..* | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
other | Σ | 1..1 | Reference(RelatedPerson | ) |
type | Σ | 1..1 | codeBinding |
Patient | |||
Short | Information about an individual or animal receiving health care services | ||
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||
Cardinality | 0..* | ||
Alias | SubjectOfCare Client Resident | ||
Constraints |
| ||
Mappings |
| ||
Patient.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
Patient.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
Patient.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
Patient.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
Patient.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
Patient.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
Patient.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
Patient.extension:ethnicCategory | |||
Short | Ethnic category | ||
Definition | The ethnicity of the subject. | ||
Cardinality | 0..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:religiousAffiliation | |||
Short | Religious affiliation | ||
Definition | The religious affiliation of the subject. | ||
Cardinality | 0..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:patient-cadavericDonor | |||
Short | Post-mortem donor status | ||
Definition | Flag indicating whether the patient authorized the donation of body parts after death. | ||
Cardinality | 0..1 | ||
Type | Extension(boolean) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:patient-cadavericDonor.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:patient-cadavericDonor.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:patient-cadavericDonor.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | ||
Mappings |
| ||
Patient.extension:patient-cadavericDonor.valueBoolean:valueBoolean | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Mappings |
| ||
Patient.extension:residentialStatus | |||
Short | The residential status of the patient | ||
Definition | The residential status of the patient. For example if this patient is a UK resident. | ||
Cardinality | 0..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:treatmentCategory | |||
Short | The treatment category for this patient | ||
Definition | The treatment category for this patient. For example if this patient is entitled to free healthcare treatment. | ||
Cardinality | 0..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:nhsCommunication | |||
Short | NHS communication preferences for a resource | ||
Definition | Communication preferences including a list of Languages which may be used for communication | ||
Cardinality | 0..* | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:nhsCommunication.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 1..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:language | |||
Short | Languages which may be used for communication | ||
Definition | Languages which may be used for communication. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:language.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:language.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:language.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | language | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:language.value[x]:valueCodeableConcept | |||
Short | Languages which may be used for communication | ||
Definition | Languages which may be used for communication. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Human Language (required) | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:preferred | |||
Short | Language preference indicator | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:preferred.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:preferred.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:preferred.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | preferred | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:preferred.valueBoolean:valueBoolean | |||
Short | Indicates whether or not this language is preferred (over other languages up a certain level) | ||
Definition | Indicates whether or not this language is preferred (over other languages up a certain level) | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:modeOfCommunication | |||
Short | Mode of communication for the selected language | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:modeOfCommunication.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:modeOfCommunication.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:modeOfCommunication.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | modeOfCommunication | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConcept | |||
Short | A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. | ||
Definition | A valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Language Ability Mode (required) | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:communicationProficiency | |||
Short | The level of proficiency in communicating a language | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:communicationProficiency.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:communicationProficiency.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:communicationProficiency.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | communicationProficiency | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConcept | |||
Short | A valueset to describe the level of proficiency in communicating a language | ||
Definition | A valueset to describe the level of proficiency in communicating a language. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Language Ability Proficiency (required) | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:interpreterRequired | |||
Short | Interpreter preference indicator | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:interpreterRequired.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:interpreterRequired.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:interpreterRequired.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | interpreterRequired | ||
Mappings |
| ||
Patient.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBoolean | |||
Short | Indicates whether an interpreter is required for communication purposes | ||
Definition | Indicates whether an interpreter is required for communication purposes- True / False? | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Mappings |
| ||
Patient.extension:nhsCommunication.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | ||
Mappings |
| ||
Patient.extension:nhsCommunication.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..0 | ||
Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta | ||
Mappings |
| ||
Patient.extension:birthPlace | |||
Short | Place of Birth for patient | ||
Definition | The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements. | ||
Cardinality | 0..1 | ||
Type | Extension(Address) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:birthPlace.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.extension:birthPlace.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.extension:birthPlace.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | http://hl7.org/fhir/StructureDefinition/birthPlace | ||
Mappings |
| ||
Patient.extension:birthPlace.valueAddress:valueAddress | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | Address | ||
Mappings |
| ||
Patient.extension:nominatedPharmacy | |||
Short | A patient's nominated pharmacy | ||
Definition | A patient's nominated pharmacy. | ||
Cardinality | 0..1 | ||
Type | Extension(Reference()) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.extension:deathNotificationStatus | |||
Short | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) | ||
Definition | This extension is constrained to represent a patient’s death notification (as held on Personal Demographics Service (PDS)). | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.identifier | |||
Short | An identifier for this patient | ||
Definition | An identifier for this patient. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||
Slicing | Unordered, Open At End, by system(Value) | ||
Mappings |
| ||
Patient.identifier:nhsNumber | |||
Short | The patient's NHS number | ||
Definition | An identifier for this patient. | ||
Cardinality | 0..1 | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||
Mappings |
| ||
Patient.identifier:nhsNumber.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.identifier:nhsNumber.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 1..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus | |||
Short | NHS number verification status | ||
Definition | The verification/tracing status of the NHS number. | ||
Cardinality | 1..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Patient.identifier:nhsNumber.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
Patient.identifier:nhsNumber.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
Patient.identifier:nhsNumber.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Fixed Value | https://fhir.nhs.uk/Id/nhs-number | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Patient.identifier:nhsNumber.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456General 1234567890 | ||
Mappings |
| ||
Patient.identifier:nhsNumber.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
Patient.identifier:nhsNumber.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
Patient.active | |||
Short | Whether this patient's record is in active use | ||
Definition | Whether this patient record is in active use. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||
Comments | Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active. | ||
Default value | true | ||
Mappings |
| ||
Patient.name | |||
Short | A name associated with the patient | ||
Definition | A name associated with the individual. | ||
Cardinality | 0..* | ||
Type | HumanName | ||
Summary | True | ||
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||
Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. | ||
Slicing | Unordered, Open At End, by use(Value) | ||
Mappings |
| ||
Patient.name:official | |||
Short | A name associated with the patient | ||
Definition | A name associated with the individual. | ||
Cardinality | 1..1 | ||
Type | HumanName | ||
Summary | True | ||
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||
Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. | ||
Mappings |
| ||
Patient.name:official.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.name:official.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.name:official.use | |||
Short | usual | official | temp | nickname | anonymous | old | maiden | ||
Definition | Identifies the purpose for this name. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The use of a human name (required) | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||
Fixed Value | official | ||
Mappings |
| ||
Patient.name:official.text | |||
Short | Text representation of the full name | ||
Definition | A full text representation of the name. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | A renderable, unencoded form. | ||
Comments | Can provide both a text representation and structured parts. | ||
Mappings |
| ||
Patient.name:official.family | |||
Short | Family name (often called 'Surname') | ||
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Alias | surname | ||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||
Mappings |
| ||
Patient.name:official.given | |||
Short | Given names (not always 'first'). Includes middle names | ||
Definition | Given name. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Alias | first name, middle name | ||
Comments | If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. | ||
Mappings |
| ||
Patient.name:official.prefix | |||
Short | Parts that come before the name | ||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Mappings |
| ||
Patient.name:official.suffix | |||
Short | Parts that come after the name | ||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Mappings |
| ||
Patient.name:official.period | |||
Short | Time period when name was/is in use | ||
Definition | Indicates the period of time when this name was valid for the named person. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Requirements | Allows names to be placed in historical context. | ||
Mappings |
| ||
Patient.telecom | |||
Short | A contact detail for the individual | ||
Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||
Cardinality | 0..* | ||
Type | ContactPoint | ||
Summary | True | ||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||
Comments | A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). | ||
Mappings |
| ||
Patient.telecom.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.telecom.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.telecom.system | |||
Short | phone | fax | email | pager | url | sms | other | ||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | Telecommunications form for contact point | ||
Summary | True | ||
Conditions | The cardinality or value of this element may be affected by these constraints: cpt-2 | ||
Mappings |
| ||
Patient.telecom.value | |||
Short | The actual contact point details | ||
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||
Mappings |
| ||
Patient.telecom.use | |||
Short | home | work | temp | old | mobile - purpose of this contact point | ||
Definition | Identifies the purpose for the contact point. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Use of contact point | ||
Modifier | True | ||
Summary | True | ||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||
Mappings |
| ||
Patient.telecom.rank | |||
Short | Specify preferred order of use (1 = highest) | ||
Definition | Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. | ||
Cardinality | 0..1 | ||
Type | positiveInt | ||
Summary | True | ||
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||
Mappings |
| ||
Patient.telecom.period | |||
Short | Time period when the contact point was/is in use | ||
Definition | Time period when the contact point was/is in use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
Patient.gender | |||
Short | male | female | other | unknown | ||
Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The gender of a person used for administrative purposes. (required) | ||
Summary | True | ||
Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes. | ||
Comments | The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error. | ||
Mappings |
| ||
Patient.birthDate | |||
Short | The date of birth for the individual | ||
Definition | The date of birth for the individual. | ||
Cardinality | 0..1 | ||
Type | date | ||
Summary | True | ||
Requirements | Age of the individual drives many clinical processes. | ||
Comments | At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems). | ||
Mappings |
| ||
Patient.birthDate.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references) | ||
Cardinality | 0..1 | ||
Type | string | ||
Patient.birthDate.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Patient.birthDate.extension:patient-birthTime | |||
Short | Time of day of birth | ||
Definition | The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. | ||
Cardinality | 0..1 | ||
Type | Extension(dateTime) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Patient.birthDate.extension:patient-birthTime.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.birthDate.extension:patient-birthTime.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.birthDate.extension:patient-birthTime.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||
Mappings |
| ||
Patient.birthDate.extension:patient-birthTime.valueDateTime:valueDateTime | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Mappings |
| ||
Patient.birthDate.value | |||
Short | Primitive value for date | ||
Definition | The actual value | ||
Cardinality | 0..1 | ||
Type | |||
Patient.deceased[x] | |||
Short | Indicates if the individual is deceased or not | ||
Definition | Indicates if the individual is deceased or not. | ||
Cardinality | 0..1 | ||
Type | boolean, dateTime | ||
Modifier | True | ||
Summary | True | ||
Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||
Comments | If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||
Mappings |
| ||
Patient.address | |||
Short | Addresses for the individual | ||
Definition | Addresses for the individual. | ||
Cardinality | 0..* | ||
Type | Address | ||
Summary | True | ||
Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||
Comments | Patient may have multiple addresses with different uses or applicable periods. | ||
Mappings |
| ||
Patient.address.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.address.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.address.use | |||
Short | home | work | temp | old - purpose of this address | ||
Definition | The purpose of this address. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The use of an address | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||
Examples | Generalhome | ||
Mappings |
| ||
Patient.address.type | |||
Short | postal | physical | both | ||
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The type of an address (physical / postal) | ||
Summary | True | ||
Examples | Generalboth | ||
Mappings |
| ||
Patient.address.text | |||
Short | Text representation of the address | ||
Definition | A full text representation of the address. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | A renderable, unencoded form. | ||
Comments | Can provide both a text representation and parts. | ||
Examples | General137 Nowhere Street, Erewhon 9132General 42 Grove Street, Overtown, West Yorkshire, LS21 1PF | ||
Mappings |
| ||
Patient.address.line | |||
Short | Street name, number, direction & P.O. Box etc. | ||
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Requirements | home | work | temp | old - purpose of this address. | ||
Examples | General137 Nowhere StreetGeneral 42 Grove Street | ||
Mappings |
| ||
Patient.address.city | |||
Short | Name of city, town etc. | ||
Definition | The name of the city, town, village or other community or delivery center. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | Municpality | ||
Examples | GeneralErewhonGeneral Overtown | ||
Mappings |
| ||
Patient.address.district | |||
Short | District name (aka county) | ||
Definition | The name of the administrative area (county). | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | County | ||
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||
Examples | GeneralMadisonGeneral West Yorkshire | ||
Mappings |
| ||
Patient.address.state | |||
Short | Sub-unit of country (abbreviations ok) | ||
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | Province, Territory | ||
Mappings |
| ||
Patient.address.postalCode | |||
Short | Postal code for area | ||
Definition | A postal code designating a region defined by the postal service. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | Zip | ||
Examples | General9132General LS21 1PF | ||
Mappings |
| ||
Patient.address.country | |||
Short | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||
Definition | Country - a nation as commonly understood or generally accepted. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | ISO 3166 3 letter codes can be used in place of a full country name. | ||
Examples | GeneralGBR | ||
Mappings |
| ||
Patient.address.period | |||
Short | Time period when address was/is in use | ||
Definition | Time period when address was/is in use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Requirements | Allows addresses to be placed in historical context. | ||
Examples | General{ "start": "2010-03-23", "end": "2010-07-01" } | ||
Mappings |
| ||
Patient.maritalStatus | |||
Short | Marital (civil) status of a patient | ||
Definition | This field contains a patient's most recent marital (civil) status. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The domestic partnership status of a person. (required) | ||
Requirements | Most, if not all systems capture it. | ||
Mappings |
| ||
Patient.maritalStatus.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.maritalStatus.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.maritalStatus.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 1..1 | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
Patient.maritalStatus.coding.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.maritalStatus.coding.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.maritalStatus.coding.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||
Examples | Generalhttp://hl7.org/fhir/v3/MaritalStatus | ||
Mappings |
| ||
Patient.maritalStatus.coding.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..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. | ||
Mappings |
| ||
Patient.maritalStatus.coding.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
Patient.maritalStatus.coding.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
Patient.maritalStatus.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
Patient.maritalStatus.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
Patient.multipleBirth[x] | |||
Short | Whether patient is part of a multiple birth | ||
Definition | Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer). | ||
Cardinality | 0..1 | ||
Type | boolean, integer | ||
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||
Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated). | ||
Mappings |
| ||
Patient.photo | |||
Short | Image of the patient | ||
Definition | Image of the patient. | ||
Cardinality | 0..* | ||
Type | Attachment | ||
Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. | ||
Mappings |
| ||
Patient.contact | |||
Short | A contact party (e.g. guardian, partner, friend) for the patient | ||
Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Requirements | Need to track people you can contact about the patient. | ||
Comments | Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. | ||
Constraints |
| ||
Mappings |
| ||
Patient.contact.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.contact.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.contact.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Patient.contact.relationship | |||
Short | The kind of relationship | ||
Definition | The nature of the relationship between the patient and the contact person. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | The nature of the relationship between a patient and a contact person for that patient. | ||
Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||
Mappings |
| ||
Patient.contact.name | |||
Short | A name associated with the contact person | ||
Definition | A name associated with the contact person. | ||
Cardinality | 1..1 | ||
Type | HumanName | ||
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||
Mappings |
| ||
Patient.contact.name.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.contact.name.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.contact.name.use | |||
Short | usual | official | temp | nickname | anonymous | old | maiden | ||
Definition | Identifies the purpose for this name. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The use of a human name | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||
Mappings |
| ||
Patient.contact.name.text | |||
Short | Text representation of the full name | ||
Definition | A full text representation of the name. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | A renderable, unencoded form. | ||
Comments | Can provide both a text representation and structured parts. | ||
Mappings |
| ||
Patient.contact.name.family | |||
Short | Family name (often called 'Surname') | ||
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | surname | ||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||
Mappings |
| ||
Patient.contact.name.given | |||
Short | Given names (not always 'first'). Includes middle names | ||
Definition | Given name. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Alias | first name, middle name | ||
Comments | If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. | ||
Mappings |
| ||
Patient.contact.name.prefix | |||
Short | Parts that come before the name | ||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Mappings |
| ||
Patient.contact.name.suffix | |||
Short | Parts that come after the name | ||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Mappings |
| ||
Patient.contact.name.period | |||
Short | Time period when name was/is in use | ||
Definition | Indicates the period of time when this name was valid for the named person. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Requirements | Allows names to be placed in historical context. | ||
Mappings |
| ||
Patient.contact.telecom | |||
Short | A contact detail for the person | ||
Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||
Cardinality | 0..* | ||
Type | ContactPoint | ||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||
Comments | Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. | ||
Mappings |
| ||
Patient.contact.address | |||
Short | Address for the contact person | ||
Definition | Address for the contact person. | ||
Cardinality | 0..1 | ||
Type | Address | ||
Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||
Mappings |
| ||
Patient.contact.address.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.contact.address.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Patient.contact.address.use | |||
Short | home | work | temp | old - purpose of this address | ||
Definition | The purpose of this address. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The use of an address | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||
Examples | Generalhome | ||
Mappings |
| ||
Patient.contact.address.type | |||
Short | postal | physical | both | ||
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The type of an address (physical / postal) | ||
Summary | True | ||
Examples | Generalboth | ||
Mappings |
| ||
Patient.contact.address.text | |||
Short | Text representation of the address | ||
Definition | A full text representation of the address. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | A renderable, unencoded form. | ||
Comments | Can provide both a text representation and parts. | ||
Examples | General137 Nowhere Street, Erewhon 9132General 120, Grove Street, Overtown, West Yorkshire, LS21 1PT | ||
Mappings |
| ||
Patient.contact.address.line | |||
Short | Street name, number, direction & P.O. Box etc. | ||
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | ||
Cardinality | 0..* | ||
Type | string | ||
Summary | True | ||
Requirements | home | work | temp | old - purpose of this address. | ||
Examples | General137 Nowhere StreetGeneral 120, Grove Street | ||
Mappings |
| ||
Patient.contact.address.city | |||
Short | Name of city, town etc. | ||
Definition | The name of the city, town, village or other community or delivery center. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | Municpality | ||
Examples | GeneralErewhonGeneral Overtown | ||
Mappings |
| ||
Patient.contact.address.district | |||
Short | District name (aka county) | ||
Definition | The name of the administrative area (county). | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | County | ||
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||
Examples | GeneralMadisonGeneral West Yorkshire | ||
Mappings |
| ||
Patient.contact.address.state | |||
Short | Sub-unit of country (abbreviations ok) | ||
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | Province, Territory | ||
Mappings |
| ||
Patient.contact.address.postalCode | |||
Short | Postal code for area | ||
Definition | A postal code designating a region defined by the postal service. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Alias | Zip | ||
Examples | General9132General LS21 1PT | ||
Mappings |
| ||
Patient.contact.address.country | |||
Short | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||
Definition | Country - a nation as commonly understood or generally accepted. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | ISO 3166 3 letter codes can be used in place of a full country name. | ||
Examples | GeneralGBR | ||
Mappings |
| ||
Patient.contact.address.period | |||
Short | Time period when address was/is in use | ||
Definition | Time period when address was/is in use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Requirements | Allows addresses to be placed in historical context. | ||
Examples | General{ "start": "2010-03-23", "end": "2010-07-01" } | ||
Mappings |
| ||
Patient.contact.gender | |||
Short | male | female | other | unknown | ||
Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The gender of a person used for administrative purposes. (required) | ||
Requirements | Needed to address the person correctly. | ||
Mappings |
| ||
Patient.contact.organization | |||
Short | Organization that is associated with the contact | ||
Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Requirements | For guardians or business related contacts, the organization is relevant. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: pat-1 | ||
Mappings |
| ||
Patient.contact.period | |||
Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||
Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Mappings |
| ||
Patient.animal | |||
Short | This patient is known to be an animal (non-human) | ||
Definition | This patient is known to be an animal. | ||
Cardinality | 0..0 | ||
Type | BackboneElement | ||
Modifier | True | ||
Summary | True | ||
Requirements | Many clinical systems are extended to care for animal patients as well as human. | ||
Comments | The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal). | ||
Constraints |
| ||
Mappings |
| ||
Patient.animal.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.animal.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.animal.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Patient.animal.species | |||
Short | E.g. Dog, Cow | ||
Definition | Identifies the high level taxonomic categorization of the kind of animal. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | The species of an animal. | ||
Summary | True | ||
Requirements | Need to know what kind of animal. | ||
Comments | If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.). | ||
Mappings |
| ||
Patient.animal.breed | |||
Short | E.g. Poodle, Angus | ||
Definition | Identifies the detailed categorization of the kind of animal. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The breed of an animal. | ||
Summary | True | ||
Requirements | May need to know the specific kind within the species. | ||
Comments | Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type. | ||
Mappings |
| ||
Patient.animal.genderStatus | |||
Short | E.g. Neutered, Intact | ||
Definition | Indicates the current state of the animal's reproductive organs. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The state of the animal's reproductive organs. | ||
Summary | True | ||
Requirements | Gender status can affect housing and animal behavior. | ||
Mappings |
| ||
Patient.communication | |||
Short | A list of Languages which may be used to communicate with the patient about his or her health | ||
Definition | Languages which may be used to communicate with the patient about his or her health. | ||
Cardinality | 0..0 | ||
Type | BackboneElement | ||
Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. | ||
Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. | ||
Constraints |
| ||
Mappings |
| ||
Patient.communication.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.communication.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.communication.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Patient.communication.language | |||
Short | The language which can be used to communicate with the patient about his or her health | ||
Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | A human language. Binding extensions
| ||
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||
Mappings |
| ||
Patient.communication.preferred | |||
Short | Language preference indicator | ||
Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. | ||
Comments | This language is specifically identified for communicating healthcare information. | ||
Mappings |
| ||
Patient.generalPractitioner | |||
Short | Patient's nominated primary care provider | ||
Definition | Patient's nominated care provider. | ||
Cardinality | 0..* | ||
Type | Reference( | ) | ||
Alias | careProvider | ||
Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. | ||
Mappings |
| ||
Patient.managingOrganization | |||
Short | Organization that is the custodian of the patient record | ||
Definition | Organization that is the custodian of the patient record. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Summary | True | ||
Requirements | Need to know who recognizes this patient record, manages and updates it. | ||
Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). | ||
Mappings |
| ||
Patient.link | |||
Short | Link to another patient resource that concerns the same actual person | ||
Definition | Link to another patient resource that concerns the same actual patient. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Modifier | True | ||
Summary | True | ||
Requirements | There are multiple usecases:
| ||
Comments | There is no assumption that linked patient records have mutual links. This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'. | ||
Constraints |
| ||
Mappings |
| ||
Patient.link.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Patient.link.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Patient.link.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Patient.link.other | |||
Short | The other patient or related person resource that the link refers to | ||
Definition | The other patient resource that the link refers to. | ||
Cardinality | 1..1 | ||
Type | Reference(RelatedPerson | ) | ||
Summary | True | ||
Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||
Mappings |
| ||
Patient.link.type | |||
Short | replaced-by | replaces | refer | seealso - type of link | ||
Definition | The type of link between this patient resource and another patient resource. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The type of link between this patient resource and another patient resource. | ||
Summary | True | ||
Mappings |
|
Practitioner
CareConnect-Practitioner-1 (Practitioner) | C | Practitioner | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
nhsCommunication | C | 0..* | Extension(Complex) |
id | 0..1 | string | |
extension | 1..* | Extension | |
language | 1..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueCodeableConcept | 1..1 | CodeableConceptBinding | |
preferred | 0..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueBoolean | 1..1 | boolean | |
modeOfCommunication | 0..* | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueCodeableConcept | 1..1 | CodeableConceptBinding | |
communicationProficiency | 0..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueCodeableConcept | 1..1 | CodeableConceptBinding | |
interpreterRequired | 0..1 | Extension | |
id | 0..1 | string | |
extension | 0..* | Extension | |
url | 1..1 | uriFixed Value | |
valueBoolean | 1..1 | boolean | |
url | 1..1 | uriFixed Value | |
value[x] | 0..0 | ||
modifierExtension | ?! | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
sdsUserID | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
sdsRoleProfileID | Σ | 0..* | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
active | Σ | 0..1 | boolean |
name | Σ | 0..* | HumanName |
telecom | Σ | 0..* | ContactPoint |
address | Σ | 0..* | Address |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
photo | 0..* | Attachment | |
qualification | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
identifier | 0..* | Identifier | |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference() |
code | 1..1 | CodeableConcept | |
period | 0..1 | Period | |
issuer | 0..1 | Reference() | |
communication | 0..0 | CodeableConceptBinding |
Practitioner | |||
Short | A person with a formal responsibility in the provisioning of healthcare or related services | ||
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. | ||
Cardinality | 0..* | ||
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual? | ||
Constraints |
| ||
Mappings |
| ||
Practitioner.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
Practitioner.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
Practitioner.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
Practitioner.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
Practitioner.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
Practitioner.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
Practitioner.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication | |||
Short | NHS communication preferences for a resource | ||
Definition | Communication preferences including a list of Languages which may be used for communication | ||
Cardinality | 0..* | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 1..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:language | |||
Short | Languages which may be used for communication | ||
Definition | Languages which may be used for communication. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:language.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:language.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:language.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | language | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:language.value[x]:valueCodeableConcept | |||
Short | Languages which may be used for communication | ||
Definition | Languages which may be used for communication. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Human Language (required) | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:preferred | |||
Short | Language preference indicator | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:preferred.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:preferred.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:preferred.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | preferred | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:preferred.valueBoolean:valueBoolean | |||
Short | Indicates whether or not this language is preferred (over other languages up a certain level) | ||
Definition | Indicates whether or not this language is preferred (over other languages up a certain level) | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:modeOfCommunication | |||
Short | Mode of communication for the selected language | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:modeOfCommunication.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:modeOfCommunication.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:modeOfCommunication.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | modeOfCommunication | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConcept | |||
Short | A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. | ||
Definition | A valueset to describe the mode the patient can communicate in, representing the method of expression of the language.. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Language Ability Mode (required) | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:communicationProficiency | |||
Short | The level of proficiency in communicating a language | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:communicationProficiency.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:communicationProficiency.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:communicationProficiency.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | communicationProficiency | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConcept | |||
Short | A valueset to describe the level of proficiency in communicating a language | ||
Definition | A valueset to describe the level of proficiency in communicating a language. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Language Ability Proficiency (required) | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:interpreterRequired | |||
Short | Interpreter preference indicator | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:interpreterRequired.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:interpreterRequired.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:interpreterRequired.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | interpreterRequired | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.extension:interpreterRequired.valueBoolean:valueBoolean | |||
Short | Indicates whether an interpreter is required for communication purposes | ||
Definition | Indicates whether an interpreter is required for communication purposes- True / False? | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | ||
Mappings |
| ||
Practitioner.extension:nhsCommunication.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..0 | ||
Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta | ||
Mappings |
| ||
Practitioner.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Practitioner.identifier | |||
Short | A identifier for the person as this agent | ||
Definition | An identifier that applies to this person in this role. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Often, specific identities are assigned for the agent. | ||
Slicing | Unordered, Open At End, by system(Value) | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID | |||
Short | A identifier for the person as this agent | ||
Definition | An identifier that applies to this person in this role. | ||
Cardinality | 0..1 | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Often, specific identities are assigned for the agent. | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Fixed Value | https://fhir.nhs.uk/Id/sds-user-id | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
Practitioner.identifier:sdsUserID.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID | |||
Short | A identifier for the person as this agent | ||
Definition | An identifier that applies to this person in this role. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Often, specific identities are assigned for the agent. | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Fixed Value | https://fhir.nhs.uk/Id/sds-role-profile-id | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
Practitioner.identifier:sdsRoleProfileID.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
Practitioner.active | |||
Short | Whether this practitioner's record is in active use | ||
Definition | Whether this practitioner's record is in active use. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. | ||
Comments | Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. | ||
Default value | true | ||
Mappings |
| ||
Practitioner.name | |||
Short | The name(s) associated with the practitioner | ||
Definition | The name(s) associated with the practitioner. | ||
Cardinality | 0..* | ||
Type | HumanName | ||
Summary | True | ||
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. | ||
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general select the value to be used in the ResourceReference.display based on this:
| ||
Mappings |
| ||
Practitioner.telecom | |||
Short | A contact detail for the practitioner (that apply to all roles) | ||
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. | ||
Cardinality | 0..* | ||
Type | ContactPoint | ||
Summary | True | ||
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have. | ||
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification These typically will have home numbers, or mobile numbers that are not role specific. | ||
Mappings |
| ||
Practitioner.address | |||
Short | Address(es) of the practitioner that are not role specific (typically home address) | ||
Definition | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. | ||
Cardinality | 0..* | ||
Type | Address | ||
Summary | True | ||
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. | ||
Comments | The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). | ||
Mappings |
| ||
Practitioner.gender | |||
Short | male | female | other | unknown | ||
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The gender of a person used for administrative purposes. (required) | ||
Summary | True | ||
Requirements | Needed to address the person correctly. | ||
Mappings |
| ||
Practitioner.birthDate | |||
Short | The date on which the practitioner was born | ||
Definition | The date of birth for the practitioner. | ||
Cardinality | 0..1 | ||
Type | date | ||
Summary | True | ||
Requirements | Needed for identification. | ||
Mappings |
| ||
Practitioner.photo | |||
Short | Image of the person | ||
Definition | Image of the person. | ||
Cardinality | 0..* | ||
Type | Attachment | ||
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. | ||
Mappings |
| ||
Practitioner.qualification | |||
Short | Qualifications obtained by training and certification | ||
Definition | Qualifications obtained by training and certification. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Practitioner.qualification.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.qualification.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
Practitioner.qualification.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | 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. | ||
Mappings |
| ||
Practitioner.qualification.identifier | |||
Short | An identifier for this qualification for the practitioner | ||
Definition | An identifier that applies to this person's qualification in this role. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Requirements | Often, specific identities are assigned for the qualification. | ||
Mappings |
| ||
Practitioner.qualification.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Practitioner.qualification.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Practitioner.qualification.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
Practitioner.qualification.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
Practitioner.qualification.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Practitioner.qualification.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
Practitioner.qualification.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
Practitioner.qualification.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
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. | ||
Mappings |
| ||
Practitioner.qualification.code | |||
Short | Coded representation of the qualification | ||
Definition | Coded representation of the qualification. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Specific qualification the practitioner has to provide a service | ||
Mappings |
| ||
Practitioner.qualification.period | |||
Short | Period during which the qualification is valid | ||
Definition | Period during which the qualification is valid. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Requirements | Qualifications are often for a limited period of time, and can be revoked. | ||
Mappings |
| ||
Practitioner.qualification.issuer | |||
Short | Organization that regulates and issues the qualification | ||
Definition | Organization that regulates and issues the qualification. | ||
Cardinality | 0..1 | ||
Type | Reference() | ||
Mappings |
| ||
Practitioner.communication | |||
Short | A language the practitioner is able to use in patient communication | ||
Definition | A language the practitioner is able to use in patient communication. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | A human language. Binding extensions
| ||
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients. | ||
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||
Mappings |
|