Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Medication

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaMedication

athena medication profile

This Medication 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 and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource captures the codes that define a medication and the medication form.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Medication 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.

Source

The Medication resource is derived from the MEDINFO and TERMINOLOGYMAP tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

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

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id S 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Medication Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
..... profile:Athena Medication Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile
... code S 1..1 CodeableConcept Codes that identify this medication
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:RXNORM 0..1 Coding Code defined by a terminology system
..... coding:DDID 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code 1..1 code Symbol in syntax defined by the system
..... coding:GPI 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code 1..1 code Symbol in syntax defined by the system
..... coding:KDC 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code 1..1 code Symbol in syntax defined by the system
..... coding:DNID 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/dnid
...... code 1..1 code Symbol in syntax defined by the system
..... coding:NDCNUM 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code 1..1 code Symbol in syntax defined by the system
.... Slices for text Content/Rules for all slices
..... text:PRODUCTNAME 1..1 string Plain text representation of the concept
.... Slices for coding 0..2 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:FDA Dose Form 0..1 Coding Code defined by a terminology system
..... coding:DOSEFORM 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code 1..1 code Symbol in syntax defined by the system
.... text 1..1 string Plain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
..... profile:Athena Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
..... coding:DDID Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:GPI Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:KDC Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:DNID Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/dnid
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:NDCNUM Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code Σ 1..1 code Symbol in syntax defined by the system
.... Slices for text Content/Rules for all slices
..... text:PRODUCTNAME Σ 1..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 1..1 CodeableConcept powder | tablets | carton +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

.... Slices for coding Σ 0..2 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:FDA Dose Form Σ 0..1 Coding Code defined by a terminology system
..... coding:DOSEFORM Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code Σ 1..1 code Symbol in syntax defined by the system
.... text Σ 1..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id SΣ 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 Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
..... profile:Athena Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* 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
... 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 Business identifier for this medication
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
..... coding:DDID Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... 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
..... coding:GPI Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... 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
..... coding:KDC Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... 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
..... coding:DNID Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/dnid
...... 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
..... coding:NDCNUM Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://hl7.org/fhir/sid/ndc
...... 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
.... Slices for text Content/Rules for all slices
..... text:PRODUCTNAME Σ 1..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 1..1 CodeableConcept powder | tablets | carton +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..2 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:FDA Dose Form Σ 0..1 Coding Code defined by a terminology system
..... coding:DOSEFORM Σ 1..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... 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
.... text Σ 1..1 string Plain text representation of the concept
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Medication.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

This structure is derived from Medication

Summary

Mandatory: 8 elements(12 nested mandatory elements)
Must-Support: 2 elements
Fixed: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.meta.profile
  • The element 1 is sliced based on the value of Medication.code.coding
  • The element 1 is sliced based on the value of Medication.form.coding

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id S 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Medication Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
..... profile:Athena Medication Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile
... code S 1..1 CodeableConcept Codes that identify this medication
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:RXNORM 0..1 Coding Code defined by a terminology system
..... coding:DDID 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code 1..1 code Symbol in syntax defined by the system
..... coding:GPI 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code 1..1 code Symbol in syntax defined by the system
..... coding:KDC 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code 1..1 code Symbol in syntax defined by the system
..... coding:DNID 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/dnid
...... code 1..1 code Symbol in syntax defined by the system
..... coding:NDCNUM 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code 1..1 code Symbol in syntax defined by the system
.... Slices for text Content/Rules for all slices
..... text:PRODUCTNAME 1..1 string Plain text representation of the concept
.... Slices for coding 0..2 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:FDA Dose Form 0..1 Coding Code defined by a terminology system
..... coding:DOSEFORM 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code 1..1 code Symbol in syntax defined by the system
.... text 1..1 string Plain text representation of the concept

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
..... profile:Athena Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
..... coding:DDID Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:GPI Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:KDC Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:DNID Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/dnid
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:NDCNUM Σ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/ndc
...... code Σ 1..1 code Symbol in syntax defined by the system
.... Slices for text Content/Rules for all slices
..... text:PRODUCTNAME Σ 1..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 1..1 CodeableConcept powder | tablets | carton +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

.... Slices for coding Σ 0..2 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:FDA Dose Form Σ 0..1 Coding Code defined by a terminology system
..... coding:DOSEFORM Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... code Σ 1..1 code Symbol in syntax defined by the system
.... text Σ 1..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
... id SΣ 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 Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
..... profile:Athena Medication Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* 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
... 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 Business identifier for this medication
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:RXNORM Σ 0..1 Coding Code defined by a terminology system
..... coding:DDID Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... 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
..... coding:GPI Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi
...... 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
..... coding:KDC Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc
...... 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
..... coding:DNID Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/dnid
...... 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
..... coding:NDCNUM Σ 0..1 Coding Code defined by a terminology 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
Fixed Value: http://hl7.org/fhir/sid/ndc
...... 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
.... Slices for text Content/Rules for all slices
..... text:PRODUCTNAME Σ 1..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 1..1 CodeableConcept powder | tablets | carton +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..2 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:FDA Dose Form Σ 0..1 Coding Code defined by a terminology system
..... coding:DOSEFORM Σ 1..1 Coding Code defined by a terminology 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
Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid
...... 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
.... text Σ 1..1 string Plain text representation of the concept
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Medication.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

This structure is derived from Medication

Summary

Mandatory: 8 elements(12 nested mandatory elements)
Must-Support: 2 elements
Fixed: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.meta.profile
  • The element 1 is sliced based on the value of Medication.code.coding
  • The element 1 is sliced based on the value of Medication.form.coding

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Medication resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/Medication?{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 Medication 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
code (token) Codes that identify this medication
form (token) powder | tablets | carton +
HTTP Response Codes

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.