Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile | Version: 23.1.0 | |||
Active as of 2022-03-01 | Computable Name: AthenaMedicationStatement |
Defines constraints and extensions on the medicationstatement resource as supported by Athena Products.
This MedicationStatement profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read, search, create and update capabilities of these products.
This resource contains a record of a medication associated with a patient. This may be a medication that was once consumed, is currently consumed, or will be consumed in future. The source of this information can be a patient, a significant other, a clinician. Prior medications are often recorded during an encounter when the patient’s medical history is taken. Because this information relies on patient memory or the clinical data available for a patient, it is less precise than medication administration recordings (see MedicationAdministration).
This profile is used to define the content that will be returned by the API Server in response to requests to access MedicationStatement resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
The profile also defines the content that must be supplied to the API Server in response to requests to populate MedicationStatement resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.
The MedicationStatement resource is derived from the MEDICATE tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.
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 | |
id | 1..1 | id | Logical id of this artifact | |
meta | 0..1 | Meta | Metadata about the resource | |
versionId | 0..1 | id | Version specific identifier | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:athena-medstatement-profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile | |
Slices for security | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 1..2 | Coding | Tags applied to this resource | |
Slices for extension | Content/Rules for all slices | |||
ndc | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
ddid | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
rxnorm | 0..1 | CodeableConcept | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-rxnorm | |
medcategory | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory" | |
value[x] | 1..1 | string | Value of extension | |
identifier | 0..* | Identifier | External identifier | |
status | 1..1 | code | active | completed | entered-in-error | intended | |
medication[x] | 1..1 | Reference(Medication) | What medication was taken | |
subject | 1..1 | Reference(Patient) | Who is/was taking the medication | |
context | 0..1 | Reference(Encounter) | Encounter / Episode associated with MedicationStatement | |
effective[x] | 1..1 | Period | Over what period was medication consumed? | |
dateAsserted | 0..1 | dateTime | When the statement was asserted? | |
informationSource | 1..1 | Reference(Practitioner) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonReference | 0..1 | Reference(Condition) | Condition or observation that supports why the medication is being/was taken | |
note | 0..1 | Annotation | Further information about the statement | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
text | 0..1 | string | Reported dosage information | |
timing | 0..1 | Timing | When medication should be administered | |
route | 0..1 | CodeableConcept | How drug should enter body | |
doseAndRate | 0..* | Element | Amount of medication administered | |
dose[x] | 0..1 | Quantity | Amount administered in one dose | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
id | Σ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:athena-medstatement-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile |
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
ndc | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
ddid | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
rxnorm | 0..1 | CodeableConcept | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-rxnorm | |
medcategory | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory" | |
value[x] | 1..1 | string | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External identifier |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
medication[x] | Σ | 1..1 | Reference(Medication) | What medication was taken |
subject | Σ | 1..1 | Reference(Patient) | Who is/was taking the medication |
context | Σ | 0..1 | Reference(Encounter) | Encounter / Episode associated with MedicationStatement |
effective[x] | Σ | 1..1 | Period | Over what period was medication consumed? |
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | 1..1 | Reference(Practitioner) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonReference | 0..1 | Reference(Condition) | Condition or observation that supports why the medication is being/was taken | |
note | 0..1 | Annotation | Further information about the statement | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
text | Σ | 0..1 | string | Reported dosage information |
timing | Σ | 0..1 | Timing | When medication should be administered |
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. |
doseAndRate | Σ | 0..* | Element | Amount of medication administered |
dose[x] | Σ | 0..1 | Quantity | Amount administered in one dose |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
MedicationStatement.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
MedicationStatement.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
MedicationStatement.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:athena-medstatement-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile | ||||
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ndc | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
ddid | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
rxnorm | 0..1 | CodeableConcept | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-rxnorm | |||||
medcategory | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory" | |||||
value[x] | 1..1 | string | Value of extension | |||||
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 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 | Reference(Medication) | What medication was taken | ||||
subject | Σ | 1..1 | Reference(Patient) | Who is/was taking the medication | ||||
context | Σ | 0..1 | Reference(Encounter) | Encounter / Episode associated with MedicationStatement | ||||
effective[x] | Σ | 1..1 | Period | Over what period was medication consumed? | ||||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? | ||||
informationSource | 1..1 | Reference(Practitioner) | 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..1 | Reference(Condition) | Condition or observation that supports why the medication is being/was taken | |||||
note | 0..1 | Annotation | Further information about the statement | |||||
dosage | 0..* | 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 | Reported dosage information | ||||
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 | Σ | 0..* | 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] | Σ | 0..1 | Quantity | Amount administered in one dose | ||||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | 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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationStatement.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
This structure is derived from MedicationStatement
Summary
Mandatory: 6 elements(11 nested mandatory elements)
Fixed: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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 | |
id | 1..1 | id | Logical id of this artifact | |
meta | 0..1 | Meta | Metadata about the resource | |
versionId | 0..1 | id | Version specific identifier | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:athena-medstatement-profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile | |
Slices for security | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 1..2 | Coding | Tags applied to this resource | |
Slices for extension | Content/Rules for all slices | |||
ndc | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
ddid | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
rxnorm | 0..1 | CodeableConcept | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-rxnorm | |
medcategory | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory" | |
value[x] | 1..1 | string | Value of extension | |
identifier | 0..* | Identifier | External identifier | |
status | 1..1 | code | active | completed | entered-in-error | intended | |
medication[x] | 1..1 | Reference(Medication) | What medication was taken | |
subject | 1..1 | Reference(Patient) | Who is/was taking the medication | |
context | 0..1 | Reference(Encounter) | Encounter / Episode associated with MedicationStatement | |
effective[x] | 1..1 | Period | Over what period was medication consumed? | |
dateAsserted | 0..1 | dateTime | When the statement was asserted? | |
informationSource | 1..1 | Reference(Practitioner) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonReference | 0..1 | Reference(Condition) | Condition or observation that supports why the medication is being/was taken | |
note | 0..1 | Annotation | Further information about the statement | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
text | 0..1 | string | Reported dosage information | |
timing | 0..1 | Timing | When medication should be administered | |
route | 0..1 | CodeableConcept | How drug should enter body | |
doseAndRate | 0..* | Element | Amount of medication administered | |
dose[x] | 0..1 | Quantity | Amount administered in one dose | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
id | Σ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:athena-medstatement-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile |
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
ndc | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
ddid | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
rxnorm | 0..1 | CodeableConcept | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-rxnorm | |
medcategory | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory" | |
value[x] | 1..1 | string | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External identifier |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
medication[x] | Σ | 1..1 | Reference(Medication) | What medication was taken |
subject | Σ | 1..1 | Reference(Patient) | Who is/was taking the medication |
context | Σ | 0..1 | Reference(Encounter) | Encounter / Episode associated with MedicationStatement |
effective[x] | Σ | 1..1 | Period | Over what period was medication consumed? |
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | 1..1 | Reference(Practitioner) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonReference | 0..1 | Reference(Condition) | Condition or observation that supports why the medication is being/was taken | |
note | 0..1 | Annotation | Further information about the statement | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
text | Σ | 0..1 | string | Reported dosage information |
timing | Σ | 0..1 | Timing | When medication should be administered |
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. |
doseAndRate | Σ | 0..* | Element | Amount of medication administered |
dose[x] | Σ | 0..1 | Quantity | Amount administered in one dose |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
MedicationStatement.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
MedicationStatement.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
MedicationStatement.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:athena-medstatement-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile | ||||
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ndc | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ndc" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
ddid | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-ddid" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
rxnorm | 0..1 | CodeableConcept | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-rxnorm | |||||
medcategory | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-extension-medcategory" | |||||
value[x] | 1..1 | string | Value of extension | |||||
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 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 | Reference(Medication) | What medication was taken | ||||
subject | Σ | 1..1 | Reference(Patient) | Who is/was taking the medication | ||||
context | Σ | 0..1 | Reference(Encounter) | Encounter / Episode associated with MedicationStatement | ||||
effective[x] | Σ | 1..1 | Period | Over what period was medication consumed? | ||||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? | ||||
informationSource | 1..1 | Reference(Practitioner) | 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..1 | Reference(Condition) | Condition or observation that supports why the medication is being/was taken | |||||
note | 0..1 | Annotation | Further information about the statement | |||||
dosage | 0..* | 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 | Reported dosage information | ||||
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 | Σ | 0..* | 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] | Σ | 0..1 | Quantity | Amount administered in one dose | ||||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | 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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationStatement.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
This structure is derived from MedicationStatement
Summary
Mandatory: 6 elements(11 nested mandatory elements)
Fixed: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Interactions supported by this resource are listed below.
Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for MedicationStatement resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/r4/MedicationStatement?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Where:
Name | Description |
---|---|
[base] | Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer |
[_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results MedicationStatement resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
[_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
[_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
_id (token) | The ID of the resource |
_lastUpdated (date) | |
_lastUpdated-fromnow (quantity) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
_security (token) | |
_tag (token) | |
ddid (token) | |
effective (date) | Date when patient was taking (or not taking) the medication |
effectivedate-fromnow (quantity) | Like effectivedate except expressed as a positive or negative offset from the current time in units of time, e.g. effectivedate-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
context (reference) | Returns statements for a specific context |
encounter-or-historical (reference) | |
identifier (token) | Return statements with this external identifier |
medication (reference) | Return administrations of this medication reference |
ndc (token) | |
patient (reference) | The identity of a patient to list statements for |
rxnorm (token) | |
source (reference) | Who the information in the statement came from |
status (token) | Return statements that match the given status |
subject (reference) | The identity of a patient to list statements for |
The following HTTP response codes are returned by this API call:
200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |