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
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
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:
This structure is derived from MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | I | 0..* | MedicationStatement | Record of medication being taken by a patient |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-CareConnect-MedicationStatementLastIssueDate-1 | I | 0..1 | dateTime | The date a prescription was last issued URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationStatementLastIssueDate-1 |
Extension-CareConnect-MedicationChangeSummary-1 | I | 0..1 | (Complex) | Optional Extensions Element URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationChangeSummary-1 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External identifier |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(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..1 | Reference(EpisodeOfCare | CareConnect-Encounter-1) | Encounter / Episode associated with MedicationStatement |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold Binding: MedicationStatementStatus (required) |
category | Σ | 0..1 | CodeableConcept | Type 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..1 | Reference(CareConnect-Medication-1) | What medication was taken |
effective[x] | Σ | 0..1 | The date/time or interval when the medication was taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | 0..1 | Reference(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..1 | Reference(Group | CareConnect-Patient-1) | Who is/was taking the medication |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
taken | ?!Σ | 1..1 | code | y | n | unk | na Binding: MedicationStatementTaken (required) |
reasonNotTaken | I | 0..* | CodeableConcept | True if asserting medication was not given Binding: SNOMED CT Drugs not taken/completed Codes (example) |
reasonCode | 0..* | CodeableConcept | Reason 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..* | Annotation | Further information about the statement | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorReference | Reference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
sequence | Σ | 0..1 | integer | The order of the dosage instructions |
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction - e.g. "with meals" Binding: SNOMED CT Additional Dosage Instructions (example) |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMED CT Route Codes (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional 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..1 | Coding | Code defined by a terminology system Binding: Care Connect Medication Dosage Route (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example) |
dose[x] | Σ | 0..1 | Amount of medication per dose | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
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:
Differential View
This structure is derived from MedicationStatement
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | I | 0..* | MedicationStatement | Record of medication being taken by a patient |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Extension-CareConnect-MedicationStatementLastIssueDate-1 | I | 0..1 | dateTime | The date a prescription was last issued URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationStatementLastIssueDate-1 |
Extension-CareConnect-MedicationChangeSummary-1 | I | 0..1 | (Complex) | Optional Extensions Element URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationChangeSummary-1 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External identifier |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(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..1 | Reference(EpisodeOfCare | CareConnect-Encounter-1) | Encounter / Episode associated with MedicationStatement |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold Binding: MedicationStatementStatus (required) |
category | Σ | 0..1 | CodeableConcept | Type 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..1 | Reference(CareConnect-Medication-1) | What medication was taken |
effective[x] | Σ | 0..1 | The date/time or interval when the medication was taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | 0..1 | Reference(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..1 | Reference(Group | CareConnect-Patient-1) | Who is/was taking the medication |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
taken | ?!Σ | 1..1 | code | y | n | unk | na Binding: MedicationStatementTaken (required) |
reasonNotTaken | I | 0..* | CodeableConcept | True if asserting medication was not given Binding: SNOMED CT Drugs not taken/completed Codes (example) |
reasonCode | 0..* | CodeableConcept | Reason 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..* | Annotation | Further information about the statement | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorReference | Reference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | 1..1 | string | The annotation - text content | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
sequence | Σ | 0..1 | integer | The order of the dosage instructions |
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction - e.g. "with meals" Binding: SNOMED CT Additional Dosage Instructions (example) |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMED CT Route Codes (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional 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..1 | Coding | Code defined by a terminology system Binding: Care Connect Medication Dosage Route (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension 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..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example) |
dose[x] | Σ | 0..1 | Amount of medication per dose | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
Documentation for this format |
Other representations of profile: Schematron
Id | Path | Details | Requirements |
dom-2 | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | MedicationStatement | If 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-3 | MedicationStatement | If 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-1 | MedicationStatement | Reason not taken is only permitted if Taken is No : reasonNotTaken.exists().not() or (taken = 'n') | |
ele-1 | MedicationStatement.extension:lastIssueDate | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | MedicationStatement.extension:lastIssueDate | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationStatement.extension:changeSummary | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | MedicationStatement.extension:changeSummary | Must have either extensions or value[x], not both : extension.exists() != value.exists() |