BSeR: Bidirectional Services_eReferral
2.0.0-connectathon - CI Build
BSeR: Bidirectional Services_eReferral
2.0.0-connectathon - CI Build
BSeR: Bidirectional Services_eReferral - Local Development build (v2.0.0-connectathon). See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-MedicationStatement | Version: 2.0.0-connectathon | |||
| Active as of 2023-04-13 | Computable Name: BSeR_MedicationStatement | |||
A statement of a patient medication history used as supporting information for a patient service request referral.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
  status | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken | |
 medication[x] | 1..1 | CodeableConcept | What medication was taken | |
 subject | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication | |
 dosage | 0..1 | Dosage | Details of how medication is/was taken or should be taken | |
 doseAndRate | 1..1 | Element | Amount of medication administered | |
| dose[x] | 1..1 | Quantity | Amount of medication per dose | |
 rate[x] | 0..1 | Ratio | Amount of medication per unit of time | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
| medication[x] | Σ | 1..1 | CodeableConcept | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication |
| dosage | 0..1 | Dosage | Details of how medication is/was taken or should be taken | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| doseAndRate | Σ | 1..1 | Element | Amount of medication administered |
| dose[x] | Σ | 1..1 | Quantity | Amount of medication per dose |
| rate[x] | Σ | 0..1 | Ratio | Amount of medication per unit of time |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationStatement.status | required | Medication Status Codes |
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationStatement | 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifier | ||||
| basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | ||||
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||
| category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
| medication[x] | Σ | 1..1 | CodeableConcept | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | ||||
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication | ||||
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
  effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
 effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? | ||||
| informationSource | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |||||
| derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
| reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
| note | 0..* | Annotation | Further information about the statement | |||||
| dosage | 0..1 | Dosage | Details of how medication is/was taken or should be taken | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
| 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: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||
| asNeededBoolean | boolean | |||||||
| asNeededCodeableConcept | CodeableConcept | |||||||
| site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
| route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
| method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
| doseAndRate | Σ | 1..1 | Element | Amount of medication administered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
| dose[x] | Σ | 1..1 | Quantity | Amount of medication per dose | ||||
| rate[x] | Σ | 0..1 | Ratio | Amount of medication per unit of time | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| MedicationStatement.language | preferred | CommonLanguages
| ||||
| MedicationStatement.status | required | Medication Status Codes | ||||
| MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes | ||||
| MedicationStatement.category | preferred | Medication usage category codes | ||||
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes | ||||
| MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodes | ||||
| MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructions | ||||
| MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes | ||||
| MedicationStatement.dosage.route | example | SNOMEDCTRouteCodes | ||||
| MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodes | ||||
| MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MedicationStatement
Differential View
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
| status | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken | |
| medication[x] | 1..1 | CodeableConcept | What medication was taken | |
| subject | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication | |
| dosage | 0..1 | Dosage | Details of how medication is/was taken or should be taken | |
| doseAndRate | 1..1 | Element | Amount of medication administered | |
| dose[x] | 1..1 | Quantity | Amount of medication per dose | |
| rate[x] | 0..1 | Ratio | Amount of medication per unit of time | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
| medication[x] | Σ | 1..1 | CodeableConcept | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication |
| dosage | 0..1 | Dosage | Details of how medication is/was taken or should be taken | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| doseAndRate | Σ | 1..1 | Element | Amount of medication administered |
| dose[x] | Σ | 1..1 | Quantity | Amount of medication per dose |
| rate[x] | Σ | 0..1 | Ratio | Amount of medication per unit of time |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationStatement.status | required | Medication Status Codes |
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationStatement | 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifier | ||||
| basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | ||||
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||
| category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
| medication[x] | Σ | 1..1 | CodeableConcept | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | ||||
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication | ||||
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
| effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? | ||||
| informationSource | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |||||
| derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
| reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
| note | 0..* | Annotation | Further information about the statement | |||||
| dosage | 0..1 | Dosage | Details of how medication is/was taken or should be taken | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
| 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: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||
| asNeededBoolean | boolean | |||||||
| asNeededCodeableConcept | CodeableConcept | |||||||
| site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
| route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
| method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
| doseAndRate | Σ | 1..1 | Element | Amount of medication administered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
| dose[x] | Σ | 1..1 | Quantity | Amount of medication per dose | ||||
| rate[x] | Σ | 0..1 | Ratio | Amount of medication per unit of time | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| MedicationStatement.language | preferred | CommonLanguages
| ||||
| MedicationStatement.status | required | Medication Status Codes | ||||
| MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes | ||||
| MedicationStatement.category | preferred | Medication usage category codes | ||||
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes | ||||
| MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodes | ||||
| MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructions | ||||
| MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes | ||||
| MedicationStatement.dosage.route | example | SNOMEDCTRouteCodes | ||||
| MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodes | ||||
| MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MedicationStatement
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.bser#2.0.0-connectathon based on FHIR 4.0.1. Generated 2023-04-13
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change