Profile: CareConnect-GPC-Medication-1
CareConnect-GPC-Medication-1 (Medication) | C | Medication | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | 0..* | Extension | |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
profile | Σ | 1..* | uri |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
MedicationTradeFamily | C | 0..1 | Extension(CodeableConcept) |
modifierExtension | ?! | 0..* | Extension |
code | Σ | 1..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 | uri |
version | Σ | 0..0 | string |
code | Σ | 1..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(CareConnect-GPC-Organization-1) |
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 | uri |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 0..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 | CareConnect-GPC-Medication-1) | ||
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(CareConnect-GPC-Medication-1) | ||
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.meta.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.meta.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.meta.versionId | |||
Short | Version specific identifier | ||
Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||
Medication.meta.lastUpdated | |||
Short | When the resource version last changed | ||
Definition | When the resource last changed - e.g. when the version changed. | ||
Cardinality | 0..1 | ||
Type | instant | ||
Summary | True | ||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||
Medication.meta.profile | |||
Short | Profiles this resource claims to conform to | ||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||
Cardinality | 1..* | ||
Type | uri | ||
Summary | True | ||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||
Medication.meta.security | |||
Short | Security Labels applied to this resource | ||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
Summary | True | ||
Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
Medication.meta.tag | |||
Short | Tags applied to this resource | ||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||
Summary | True | ||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
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. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
Medication.extension:MedicationTradeFamily | |||
Short | Optional Extensions Element | ||
Definition | Optional Extension Element - found in all resources. | ||
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 |
| ||
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 | 1..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 | ||
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 | 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. | ||
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..0 | ||
Type | string | ||
Summary | True | ||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||
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 | 1..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(CareConnect-GPC-Organization-1) | ||
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 | ||
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. | ||
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..0 | ||
Type | string | ||
Summary | True | ||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||
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 | 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.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 | CareConnect-GPC-Medication-1), 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(CareConnect-GPC-Medication-1), 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 |
|
Related links
DAPB4013: Medicine and Allergy/Intolerance Data Transfer CareConnect-Medication-1 CareConnect-GPC-Medication-1 UKCore-MedicationData model element usage
Element | Use | CareConnect (STU3) | UK Core (R4) |
---|---|---|---|
id | |||
meta.versionId | |||
meta.lastUpdated | |||
meta.profile | |||
meta.security | |||
meta.tag | |||
code | |||
status | |||
isBrand | |||
isOverTheCounter | |||
manufacturer | |||
form | |||
ingredient | |||
package | |||
image | |||
extension(MedicationTradeFamily) |
id
Usage
OptionalGuidance
It is recommended this is the medication unique dm+d concept id. This use of this identifier will provide a unique mechanism to return a Medication resource in a RESTful implementation anywhere across the NHS.For example: https://my.fhir.server/medication/87652004Where87652004
in this example is the unique dm+d concept id for the Virtual Therapeutic Moiety for Atenolol.Where a medication is not within the dm+d and therefore does not have a dm+d code then the approach will be a local implementation decision. If you have a local FHIR Medication Resource server that is being used to share drug data locally then using the Medication Reference URL is OK.If the data is being shared outside of the local environment then the Medication resource should only reference dm+d data.Example
<id value="https://my.fhir.server/medication/87652004"/>
meta.versionId
Usage
OptionalGuidance
The population of themeta.versionId
element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.Example
<meta> <versionId value="1" /> </meta>
meta.lastUpdated
Usage
OptionalGuidance
Themeta.lastUpdated
element could be useful alongside the meta.versionId
element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.Example
<meta> <lastUpdated value="2022-10-28T08:06:00+00:00" /> </meta>
meta.profile
Usage
MandatoryGuidance
Themeta.profile
contains a fixed value of the URL for the CareConnect-GPC-Medication-1
profile.Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Medication-1" /> </meta>
meta.security
Usage
OptionalGuidance
The security label(s) applicable to the resource.See Resources not to be disclosed to a patient for more details on how to populate the element.Example
<meta> <security> <system value="http://hl7.org/fhir/v3/ActCode"/> <code value="NOPAT"/> <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/> </security> </meta>
meta.tag
Usage
OptionalGuidance
A use-case for themeta.tag
element within GP Connect has not been defined.Example
<meta> <tag> <coding> <system value="http://hl7.org/fhir/common-tags" /> <code value="actionable" /> <display value="Actionable" /> </coding> </tag> </meta>
code
Usage
MandatoryGuidance
RxNorm
, SNOMED CT
, IDMP
etc. It could also be a national or local formulary code, optionally with translations to other code systems.
- The
code.coding.code
must be the NHS dm+d concept code. - The
code.coding.display
must be the NHS dm+d concept description.
Example
<code> <coding> <system value="https://dmd.nhs.uk" /> <code value="36126411000001107" /> <display value="Morphine 10mg modified-release capsules" /> </coding> </code>
status
Usage
OptionalGuidance
A use-case for populating thestatus
element within this capability has not been defined.Example
<status value="active" />
isBrand
Usage
OptionalGuidance
R4
so should not be implemented as part of an STU3
or CareConnect
implementation.
Example
<isBrand value="false" />
isOverTheCounter
Usage
OptionalGuidance
R4
so should not be implemented as part of an STU3
or CareConnect
implementation.
Example
<isOverTheCounter value="false" />
manufacturer
Usage
OptionalGuidance
A use-case for populating themanufacturer
element within this capability has not been defined.Example
<manufacturer> <reference value="organization-yy7120" /> </manufacturer>
form
Usage
OptionalGuidance
Within the dm+d terminology, the VMP, AMP, VMPP and AMPP concepts include a coded form.Where a medication is identified using a VTM concept and the prescriber wishes to qualify with a form then use this element.Coded forms should be taken from either the dm+d or from the SNOMED-CT hierarchy as a descendant of the concept 736542009 Pharmaceutical dose form.Example
<form> <coding> <system value="http://snomed.info/sct" /> <code value="427129005" /> <display value="Conventional release oral coated capsule (dose form)" /> </coding> </form>
ingredient
Usage
OptionalGuidance
A use-case for populating theingredient
element within this capability has not been defined.Example
<ingredient> <itemReference value="substance-medication-1000239" /> <isActive value="true" /> <amount> <numerator> <value value="1" /> </numerator> <denominator> <value value="1" /> </denominator> </amount> </ingredient>
package
Usage
OptionalGuidance
R4
so should not be implemented as part of an STU3
or CareConnect
implementation.
Example
<package> <container> <coding> <system value="http://hl7.org/fhir/medication-package-form" /> <code value="box" /> <display value="Box" /> </coding> <text value="A container with a flat base and sides, typically square or rectangular and having a lid." /> </container> <content> <itemReference value="medication-882qwf" /> <amount> <system value="http://unitsofmeasure.org" /> <value value="500"> <unit value="milliliter" /> <code value="mL" /> </amount> </content> <batch> <lotNumber value="1x495b" /> <expirationDate value="2023-01-01T00:00:00Z" /> </batch> </package>
image
Usage
OptionalGuidance
R4
so should not be implemented as part of an STU3
or CareConnect
implementation.
Example
<image> <contentType value="application/jpg" /> <language value="en-UK" /> <data value="[base64 encoded content]" /> <url value="http://www.example.example/product/id/8ajsud/image/thumbnail.png" /> <size value="55" /> <hash value="[base64 encoded content" /> <title value="Product image" /> <creation value="2022-09-28T09:44:00Z" /> </image>
extension(MedicationTradeFamily)
Usage
RequiredGuidance
An extension to record the Trade Family or brand associated with a Medication.Example
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-GPConnect-MedicationTradeFamily-1"> <valueCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="9298001000001101" /> <display value="Panadol Extra" /> </coding> </valueCodeableConcept> </extension>