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 | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 1..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| MedicationTradeFamily | C | 0..1 | Extension(CodeableConcept) |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | Σ | 0..* | Identifier |
| code | Σ | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| descriptionId | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueId | id | ||
| descriptionDisplay | C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 | ||
| system | Σ | 1..1 | 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 |
| manufacturer | Σ C | 0..1 | Reference(CareConnect-GPC-Organization-1) |
| form | 0..1 | CodeableConceptBinding | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| descriptionId | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueId | id | ||
| descriptionDisplay | C | 0..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 | ||
| system | Σ | 1..1 | uri |
| version | Σ | 0..0 | string |
| code | Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| amount | Σ C | 0..1 | Ratio |
| ingredient | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| item[x] | 1..1 | ||
| itemCodeableConcept | CodeableConcept | ||
| itemReference | Reference(Substance) | Reference(CareConnect-GPC-Medication-1) | ||
| isActive | 0..1 | boolean | |
| strength | C | 0..1 | Ratio |
| batch | 0..1 | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| lotNumber | 0..1 | string | |
| expirationDate | 0..1 | dateTime | |
| package |
| Medication | C | |||
| Short | Definition of a Medication | |||
| Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 might not always be associated with version changes to the resource. | |||
| Cardinality | 0..1 | |||
| Type | Meta | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.meta.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.meta.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.meta.versionId | Σ | |||
| Short | Version specific identifier | |||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Summary | True | |||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.meta.source | Σ | |||
| Short | Identifies where the resource comes from | |||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 | canonical(StructureDefinition) | |||
| Summary | True | |||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Modifier | True | |||
| Summary | True | |||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.text | ||||
| Short | Text summary of the resource, for human interpretation | |||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |||
| Cardinality | 0..1 | |||
| Type | Narrative | |||
| Alias | narrative, html, xhtml, display | |||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |||
| Mappings |
| |||
| Medication.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.extension:MedicationTradeFamily | C | |||
| 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 | ?! C | |||
| Short | Extensions that cannot be ignored | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Alias | extensions, user content | |||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.identifier | Σ | |||
| Short | Business identifier for this medication | |||
| Definition | Business identifier for this medication. | |||
| Cardinality | 0..* | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | The serial number could be included as an identifier. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.code.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 alternative encodings within a code system, and translations to other code systems. | |||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.code.coding.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID | C | |||
| Short | The SNOMED CT Description ID for the display | |||
| Definition | The SNOMED CT Description ID for the display. | |||
| Cardinality | 0..1 | |||
| Type | Extension(Complex) | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 1..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionId | C | |||
| Short | The SNOMED CT Description ID | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 1..1 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionId.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionId.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionId.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionId | |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionId.value[x] | ||||
| Short | The SNOMED CT Description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay | C | |||
| Short | The SNOMED CT display for the description ID | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..1 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionDisplay | |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x] | ||||
| Short | The SNOMED CT display for the description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||
| Mappings |
| |||
| Medication.code.coding.extension:snomedCTDescriptionID.value[x] | ||||
| Short | Value of extension | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..0 | |||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | code | CodeableConcept | Coding | ContactPoint | Count | date | dateTime | decimal | Distance | Duration | HumanName | id | Identifier | instant | integer | markdown | Money | oid | Period | positiveInt | Quantity | Range | Ratio | Reference | SampledData | Signature | string | time | Timing | unsignedInt | uri | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 reference to some definition that establishes the system clearly and unambiguously. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 - e.g. off a pick list of available items (codes or displays). | |||
| Cardinality | 0..1 | |||
| Type | boolean | |||
| Summary | True | |||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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. | |||
| Modifier | True | |||
| Summary | True | |||
| Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.manufacturer | Σ C | |||
| 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 | |||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.form.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 alternative encodings within a code system, and translations to other code systems. | |||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.form.coding.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID | C | |||
| Short | The SNOMED CT Description ID for the display | |||
| Definition | The SNOMED CT Description ID for the display. | |||
| Cardinality | 0..1 | |||
| Type | Extension(Complex) | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 1..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionId | C | |||
| Short | The SNOMED CT Description ID | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 1..1 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionId.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionId.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionId.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionId | |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionId.value[x] | ||||
| Short | The SNOMED CT Description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay | C | |||
| Short | The SNOMED CT display for the description ID | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..1 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..0 | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | descriptionDisplay | |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x] | ||||
| Short | The SNOMED CT display for the description ID | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.url | ||||
| Short | identifies the meaning of the extension | |||
| Definition | Source of the definition for the extension code - a logical name or a URL. | |||
| Cardinality | 1..1 | |||
| Type | uri | |||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | |||
| Fixed Value | https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||
| Mappings |
| |||
| Medication.form.coding.extension:snomedCTDescriptionID.value[x] | ||||
| Short | Value of extension | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |||
| Cardinality | 0..0 | |||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | code | CodeableConcept | Coding | ContactPoint | Count | date | dateTime | decimal | Distance | Duration | HumanName | id | Identifier | instant | integer | markdown | Money | oid | Period | positiveInt | Quantity | Range | Ratio | Reference | SampledData | Signature | string | time | Timing | unsignedInt | uri | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 reference to some definition that establishes the system clearly and unambiguously. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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 - e.g. off a pick list of available items (codes or displays). | |||
| Cardinality | 0..1 | |||
| Type | boolean | |||
| Summary | True | |||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.amount | Σ C | |||
| Short | Amount of drug in package | |||
| Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). | |||
| Cardinality | 0..1 | |||
| Type | Ratio | |||
| Summary | True | |||
| Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.ingredient.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.ingredient.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.ingredient.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.ingredient.item[x] | ||||
| Short | The actual ingredient or content | |||
| Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. | |||
| Cardinality | 1..1 | |||
| Type | CodeableConcept | Reference(Substance) | Reference(CareConnect-GPC-Medication-1) | |||
| Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| 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). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.ingredient.strength | C | |||
| 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 | |||
| Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.batch | ||||
| Short | Details about packaged medications | |||
| Definition | Information that only applies to packages (not products). | |||
| Cardinality | 0..1 | |||
| Type | BackboneElement | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.batch.id | ||||
| Short | Unique id for inter-element referencing | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| Medication.batch.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.batch.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.batch.lotNumber | ||||
| Short | Identifier assigned to batch | |||
| Definition | The assigned lot number of a batch of the specified product. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.batch.expirationDate | ||||
| Short | When batch will expire | |||
| Definition | When this specific batch of product will expire. | |||
| Cardinality | 0..1 | |||
| Type | dateTime | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| Medication.package | ||||
Reference
Canonical URI: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Medication-1
The canonical URI is the stable FHIR identifier for this profile and is not currently available as a browsable web page.
Related links
DAPB4013: Medicine and Allergy/Intolerance Data Transfer
Related UK Core profile: UKCore-Medication
The UK Core profile is included for reference. It is based on FHIR R4 and are not part of the GP Connect STU3 standard and must not be used as the conformance or validation profile for GP Connect STU3 resources.
Data 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
Optional
Guidance
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/87652004
Where 87652004 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.profile
Usage
Mandatory
Guidance
The meta.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
Optional
Guidance
The security label(s) applicable to the resource.
See Resources not to be disclosed to a patient for more details on how to populate the element.
Example
<meta> <security> <system value="http://hl7.org/fhir/v3/ActCode"/> <code value="NOPAT"/> <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/> </security> </meta>
meta.tag
Usage
Optional
Guidance
A use-case for the meta.tag element within GP Connect has not been defined.
Example
<meta> <tag> <coding> <system value="http://hl7.org/fhir/common-tags" /> <code value="actionable" /> <display value="Actionable" /> </coding> </tag> </meta>
code
Usage
Mandatory
Guidance
RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
All medication must be represented using NHS dm+d terminology.
- The
code.coding.codemust be the NHS dm+d concept code. - The
code.coding.displaymust 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
Optional
Guidance
A use-case for populating the status element within this capability has not been defined.
Example
<status value="active" />
isBrand
Usage
Optional
Guidance
R4 so should not be implemented as part of an STU3 or CareConnect implementation.
Example
<isBrand value="false" />
isOverTheCounter
Usage
Optional
Guidance
R4 so should not be implemented as part of an STU3 or CareConnect implementation.
Example
<isOverTheCounter value="false" />
manufacturer
Usage
Optional
Guidance
A use-case for populating the manufacturer element within this capability has not been defined.
Example
<manufacturer> <reference value="organization-yy7120" /> </manufacturer>
form
Usage
Optional
Guidance
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
Optional
Guidance
A use-case for populating the ingredient 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>
image
Usage
Optional
Guidance
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
Required
Guidance
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>
Medication elements not in use
The following elements SHALL NOT be populated:
meta.versionId
meta.lastUpdated
package
Also do not populate any sub-elements of package.