IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot Ireland flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: IE Core Medication Profile

Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-medication Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: IECoreMedicationProfile
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.34

Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License

The IE Core Medication Profile inherits from the FHIR Medication resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Medication resource to record, search, and fetch medications associated with a patient. When referencing a medication, the MedicationRequest resource can use a code or refer to this profile. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

Queries on Medication resources are expected to be within the context of a MedicationRequest resource query. The following are example usage scenarios for the IE Core Medication profile:

  • Read Medication resources referenced in MedicationRequest resources.

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Medication Must Have:

  1. A medication code

Profile Specific Implementation Guidance:

  • HPRA concepts are defined as an extensible binding.
  • Since the binding is extensible when a code is unavailable, just text is allowed.
  • When the medication is compounded and is a list of ingredients, the code is still present and may contain only the text.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Definition of a Medication
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: IE Core Medication Codes (extensible)
ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeextensibleIECoreMedicationCodes (a valid code from IE Core HPRA HM)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-medication-codes
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • See the Scopes Format section for a description of the SMART scopes syntax.
  • See the Search Syntax section for a description of the IE Core search syntax.
  • See the General Requirements section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

IE Core Scopes

Servers providing access to data MAY support these IE Core SMART Scopes:

No required search criteria for ie-core-medication profile.