Argonaut Data Query Implementation Guide Version 1.0.0

This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-argo-medication

When referring to medications, The MedicationStatement and MedicationOrder resources can either use a code or refer to a Medication resource. This profile sets minimum expectations for the Medication resource to record search and fetch medications associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

Queries on Medication resource are expected to be within the context of a MedicationStatement, MedicationOrder resource query. The following are example usage scenarios for the Argonaut Medication profile:

  • Query for Medications with a particular code
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Medication must have:

  1. A medication code

Profile specific implementation guidance:

  • none

Examples

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://fhir.org/guides/argonaut/StructureDefinition/argo-medication

This profile builds on Medication.

This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.

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

Complete Summary of the Mandatory Requirements

  1. Either:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*Argonaut Medication Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (RxNorm) (extensible)
... isBrand Σ0..1booleanTrue if a brand
... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... product 0..1BackboneElementAdministrable medication details
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... form 0..1CodeableConceptpowder | tablets | carton +
Binding: SNOMED CT Form Codes (example)
.... ingredient 0..*BackboneElementActive or inactive ingredient
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... item 1..1Reference(Substance), Reference(Medication)The product contained
..... amount 0..1RatioQuantity of ingredient present
.... batch 0..*BackboneElement
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1string
..... expirationDate 0..1dateTime
... package 0..1BackboneElementDetails about packaged medications
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: SNOMED CT Form Codes (example)
.... content 0..*BackboneElementWhat is in the package
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... item 1..1Reference(Medication)A product in the package
..... amount 0..1SimpleQuantityQuantity present in the package

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. Either:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*Argonaut Medication Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (RxNorm) (extensible)
... isBrand Σ0..1booleanTrue if a brand
... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... product 0..1BackboneElementAdministrable medication details
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... form 0..1CodeableConceptpowder | tablets | carton +
Binding: SNOMED CT Form Codes (example)
.... ingredient 0..*BackboneElementActive or inactive ingredient
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... item 1..1Reference(Substance), Reference(Medication)The product contained
..... amount 0..1RatioQuantity of ingredient present
.... batch 0..*BackboneElement
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1string
..... expirationDate 0..1dateTime
... package 0..1BackboneElementDetails about packaged medications
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: SNOMED CT Form Codes (example)
.... content 0..*BackboneElementWhat is in the package
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... item 1..1Reference(Medication)A product in the package
..... amount 0..1SimpleQuantityQuantity present in the package

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.

No Search criteria for argo-medication extension.