INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

StructureDefinition: CareConnect-MedicationStatement-1

This MedicationStatement Resource is a record of a medication that is being consumed by a patient.

The official URL for this profile is:

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-MedicationStatement-1

Formal Views of Profile Content

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

This structure is derived from MedicationStatement

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationStatement.dosage.route.coding is sliced based on the value of value:system

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*MedicationStatement
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... Extension-CareConnect-MedicationStatementLastIssueDate-1 0..1dateTimeThe date a prescription was last issued
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationStatementLastIssueDate-1
... Extension-CareConnect-MedicationChangeSummary-1 0..1(Complex)Optional Extensions Element
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationChangeSummary-1
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... basedOn 0..*Reference(CarePlan | ProcedureRequest | ReferralRequest | CareConnect-MedicationRequest-1)
... partOf 0..*Reference(MedicationAdministration | CareConnect-Procedure-1 | CareConnect-Observation-1 | CareConnect-MedicationStatement-1 | CareConnect-MedicationDispense-1)
... context 0..1Reference(EpisodeOfCare | CareConnect-Encounter-1)
... medicationReference:medicationReference 1..1Reference(CareConnect-Medication-1)Binding: SNOMED CT Medication Codes (example)
... informationSource 0..1Reference(RelatedPerson | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)
... subject 1..1Reference(Group | CareConnect-Patient-1)
... reasonReference 0..*Reference(CareConnect-Observation-1 | CareConnect-Condition-1)
... note
.... author[x] 0..1
..... authorReferenceReference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1)
..... authorStringstring
... dosage
.... route
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingBinding: Care Connect Medication Dosage Route (example)
....... extension 0..*ExtensionSlice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriFixed Value: http://snomed.info/sct
....... code 1..1code
....... display 1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*MedicationStatementRecord of medication being taken by a patient
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-CareConnect-MedicationStatementLastIssueDate-1 I0..1dateTimeThe date a prescription was last issued
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationStatementLastIssueDate-1
... Extension-CareConnect-MedicationChangeSummary-1 I0..1(Complex)Optional Extensions Element
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationChangeSummary-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CarePlan | ProcedureRequest | ReferralRequest | CareConnect-MedicationRequest-1)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | CareConnect-Procedure-1 | CareConnect-Observation-1 | CareConnect-MedicationStatement-1 | CareConnect-MedicationDispense-1)Part of referenced event
... context Σ0..1Reference(EpisodeOfCare | CareConnect-Encounter-1)Encounter / Episode associated with MedicationStatement
... status ?!Σ1..1codeactive | completed | entered-in-error | intended | stopped | on-hold
Binding: MedicationStatementStatus (required)
... category Σ0..1CodeableConceptType of medication usage
Binding: MedicationStatementCategory (preferred)
... medication[x] Σ1..1(Slice Definition)What medication was taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ1..1Reference(CareConnect-Medication-1)What medication was taken
... effective[x] Σ0..1The date/time or interval when the medication was taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted Σ0..1dateTimeWhen the statement was asserted?
... informationSource 0..1Reference(RelatedPerson | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)Person or organization that provided the information about the taking of this medication
... subject Σ1..1Reference(Group | CareConnect-Patient-1)Who is/was taking the medication
... derivedFrom 0..*Reference(Resource)Additional supporting information
... taken ?!Σ1..1codey | n | unk | na
Binding: MedicationStatementTaken (required)
... reasonNotTaken I0..*CodeableConceptTrue if asserting medication was not given
Binding: SNOMED CT Drugs not taken/completed Codes (example)
... reasonCode 0..*CodeableConceptReason for why the medication is being/was taken
Binding: Condition/Problem/Diagnosis Codes (example)
... reasonReference 0..*Reference(CareConnect-Observation-1 | CareConnect-Condition-1)Condition or observation that supports why the medication is being/was taken
... note 0..*AnnotationFurther information about the statement
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... dosage 0..*DosageDetails of how medication is/was taken or should be taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... sequence Σ0..1integerThe order of the dosage instructions
.... text Σ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction Σ0..*CodeableConceptSupplemental instruction - e.g. "with meals"
Binding: SNOMED CT Additional Dosage Instructions (example)
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: SNOMED CT Medication As Needed Reason Codes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Medication Dosage Route (example)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... Extension-coding-sctdescid 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
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMED CT Administration Method Codes (example)
.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)

doco Documentation for this format

This structure is derived from MedicationStatement

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationStatement.dosage.route.coding is sliced based on the value of value:system

Differential View

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*MedicationStatement
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... Extension-CareConnect-MedicationStatementLastIssueDate-1 0..1dateTimeThe date a prescription was last issued
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationStatementLastIssueDate-1
... Extension-CareConnect-MedicationChangeSummary-1 0..1(Complex)Optional Extensions Element
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationChangeSummary-1
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... basedOn 0..*Reference(CarePlan | ProcedureRequest | ReferralRequest | CareConnect-MedicationRequest-1)
... partOf 0..*Reference(MedicationAdministration | CareConnect-Procedure-1 | CareConnect-Observation-1 | CareConnect-MedicationStatement-1 | CareConnect-MedicationDispense-1)
... context 0..1Reference(EpisodeOfCare | CareConnect-Encounter-1)
... medicationReference:medicationReference 1..1Reference(CareConnect-Medication-1)Binding: SNOMED CT Medication Codes (example)
... informationSource 0..1Reference(RelatedPerson | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)
... subject 1..1Reference(Group | CareConnect-Patient-1)
... reasonReference 0..*Reference(CareConnect-Observation-1 | CareConnect-Condition-1)
... note
.... author[x] 0..1
..... authorReferenceReference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1)
..... authorStringstring
... dosage
.... route
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1CodingBinding: Care Connect Medication Dosage Route (example)
....... extension 0..*ExtensionSlice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriFixed Value: http://snomed.info/sct
....... code 1..1code
....... display 1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*MedicationStatementRecord of medication being taken by a patient
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-CareConnect-MedicationStatementLastIssueDate-1 I0..1dateTimeThe date a prescription was last issued
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationStatementLastIssueDate-1
... Extension-CareConnect-MedicationChangeSummary-1 I0..1(Complex)Optional Extensions Element
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationChangeSummary-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CarePlan | ProcedureRequest | ReferralRequest | CareConnect-MedicationRequest-1)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | CareConnect-Procedure-1 | CareConnect-Observation-1 | CareConnect-MedicationStatement-1 | CareConnect-MedicationDispense-1)Part of referenced event
... context Σ0..1Reference(EpisodeOfCare | CareConnect-Encounter-1)Encounter / Episode associated with MedicationStatement
... status ?!Σ1..1codeactive | completed | entered-in-error | intended | stopped | on-hold
Binding: MedicationStatementStatus (required)
... category Σ0..1CodeableConceptType of medication usage
Binding: MedicationStatementCategory (preferred)
... medication[x] Σ1..1(Slice Definition)What medication was taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ1..1Reference(CareConnect-Medication-1)What medication was taken
... effective[x] Σ0..1The date/time or interval when the medication was taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted Σ0..1dateTimeWhen the statement was asserted?
... informationSource 0..1Reference(RelatedPerson | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1)Person or organization that provided the information about the taking of this medication
... subject Σ1..1Reference(Group | CareConnect-Patient-1)Who is/was taking the medication
... derivedFrom 0..*Reference(Resource)Additional supporting information
... taken ?!Σ1..1codey | n | unk | na
Binding: MedicationStatementTaken (required)
... reasonNotTaken I0..*CodeableConceptTrue if asserting medication was not given
Binding: SNOMED CT Drugs not taken/completed Codes (example)
... reasonCode 0..*CodeableConceptReason for why the medication is being/was taken
Binding: Condition/Problem/Diagnosis Codes (example)
... reasonReference 0..*Reference(CareConnect-Observation-1 | CareConnect-Condition-1)Condition or observation that supports why the medication is being/was taken
... note 0..*AnnotationFurther information about the statement
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... dosage 0..*DosageDetails of how medication is/was taken or should be taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... sequence Σ0..1integerThe order of the dosage instructions
.... text Σ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction Σ0..*CodeableConceptSupplemental instruction - e.g. "with meals"
Binding: SNOMED CT Additional Dosage Instructions (example)
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: SNOMED CT Medication As Needed Reason Codes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Medication Dosage Route (example)
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... Extension-coding-sctdescid 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
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMED CT Administration Method Codes (example)
.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
MedicationStatement.languageextensibleCommon Languages
Max Binding: All Languages
MedicationStatement.identifier.userequiredIdentifierUse
MedicationStatement.identifier.typeextensibleIdentifier Type Codes
MedicationStatement.statusrequiredMedicationStatementStatus
MedicationStatement.categorypreferredMedicationStatementCategory
MedicationStatement.takenrequiredMedicationStatementTaken
MedicationStatement.reasonNotTakenexampleSNOMED CT Drugs not taken/completed Codes
MedicationStatement.reasonCodeexampleCondition/Problem/Diagnosis Codes
MedicationStatement.dosage.additionalInstructionexampleSNOMED CT Additional Dosage Instructions
MedicationStatement.dosage.asNeeded[x]exampleSNOMED CT Medication As Needed Reason Codes
MedicationStatement.dosage.siteexampleSNOMED CT Anatomical Structure for Administration Site Codes
MedicationStatement.dosage.routeexampleSNOMED CT Route Codes
MedicationStatement.dosage.route.coding:snomedCTexampleCare Connect Medication Dosage Route
MedicationStatement.dosage.methodexampleSNOMED CT Administration Method Codes

Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MedicationStatementIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MedicationStatementIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3MedicationStatementIf 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()
mst-1MedicationStatementReason not taken is only permitted if Taken is No
: reasonNotTaken.exists().not() or (taken = 'n')
ele-1MedicationStatement.extension:lastIssueDateAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1MedicationStatement.extension:lastIssueDateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1MedicationStatement.extension:changeSummaryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1MedicationStatement.extension:changeSummaryMust have either extensions or value[x], not both
: extension.exists() != value.exists()