Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnectMedication1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Medication-1 Version: 0.1.0
Draft as of 2018-11-05 Computable Name: CareConnect-Medication-1

Copyright/Legal: Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html

This Medication Resource is primarily used for the identification and definition of a medication.

CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... code 0..1CodeableConceptCodes that identify this medication
Binding: Care Connect Medication Code (required): 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

.... coding
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
... manufacturer 0..1Reference(CareConnect-Organization-1)Manufacturer of the item
... form 0..1CodeableConceptCodes that describe a medication dose form
Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form

.... coding
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... item[x] 1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)
... package
.... content
..... item[x] 1..1The item in the package
...... itemCodeableConceptCodeableConcept
...... itemReferenceReference(CareConnect-Medication-1)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: Care Connect Medication Code (required): 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

... form 0..1CodeableConceptCodes that describe a medication dose form
Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: Care Connect Medication Code (required): 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

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required): A coded concept defining if the medication is in active use

... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(CareConnect-Organization-1)Manufacturer of the item
... form 0..1CodeableConceptCodes that describe a medication dose form
Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioQuantity of ingredient present
... package 0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example): A coded concept defining the kind of container a medication package is packaged in

.... content 0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1The item in the package
...... itemCodeableConceptCodeableConcept
...... itemReferenceReference(CareConnect-Medication-1)
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch 0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.coderequiredCare Connect Medication Code
Medication.statusrequiredMedicationStatus
Medication.formrequiredCare Connect Medication Form
Medication.package.containerexampleMedicationContainer

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from Medication

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... code 0..1CodeableConceptCodes that identify this medication
Binding: Care Connect Medication Code (required): 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

.... coding
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
... manufacturer 0..1Reference(CareConnect-Organization-1)Manufacturer of the item
... form 0..1CodeableConceptCodes that describe a medication dose form
Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form

.... coding
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... item[x] 1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)
... package
.... content
..... item[x] 1..1The item in the package
...... itemCodeableConceptCodeableConcept
...... itemReferenceReference(CareConnect-Medication-1)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: Care Connect Medication Code (required): 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

... form 0..1CodeableConceptCodes that describe a medication dose form
Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: Care Connect Medication Code (required): 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

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required): A coded concept defining if the medication is in active use

... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(CareConnect-Organization-1)Manufacturer of the item
... form 0..1CodeableConceptCodes that describe a medication dose form
Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioQuantity of ingredient present
... package 0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example): A coded concept defining the kind of container a medication package is packaged in

.... content 0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1The item in the package
...... itemCodeableConceptCodeableConcept
...... itemReferenceReference(CareConnect-Medication-1)
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch 0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.coderequiredCare Connect Medication Code
Medication.statusrequiredMedicationStatus
Medication.formrequiredCare Connect Medication Form
Medication.package.containerexampleMedicationContainer

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from Medication

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron