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

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

Home

Official URL: http://iehr.ai/fhir/ie/core/ImplementationGuide/iehr.fhir.ie.core Version: 1.0.0-ballot
IG Standards status: Trial-use Maturity Level: 3 Computable Name: IECore
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690

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

Where possible, new and updated pre-publishing content is highlighted with green text and background- This highlighting will be removed prior to publication.

Key updates and detailed changes between this and prior versions are available on the IE Core Change Log page.

Introduction

The IE Core profiles have become essential for Irish FHIR implementation guides. iEHR IE Core Data for Interoperability (IECDI) reflects changes to eHelath Ireland, Health Information and Quality Authority, The Irish College of General Practitioners Software Management Systems Requirements, and feedback from the FHIR community. The Future of IE Core page outlines the approach to yearly updates. Under the guidance of iEHR FHIR Steering Committee, future versions will expand to meet the specific needs of the Irish healthcare system.

The IE Core Implementation Guide, based on FHIR Version R4, defines the minimum constraints on FHIR resources to create the IE Core Profiles. It identifies necessary elements, extensions, vocabularies, and value sets, and details their usage. It also documents the minimum FHIR RESTful interactions required for each IE Core Profile to access patient data. Establishing this "floor" of standards promotes interoperability and adoption through common implementation, allowing for further standards development for specific use cases. There are two ways to implement IE Core:

  1. Profile Only Support: Systems may support only the IE Core Profiles to represent clinical information.
  2. Profile Support + Interaction Support: Systems may support both the IE Core Profile content structure and the RESTful interactions defined for a resource.

For a detailed description of these different usages of IE Core, see the Conformance Requirements page.

How To Read This Guide

This Guide is divided into several pages, which are listed at the top of each page in the menu bar.

  • Home: The home page provides the introduction and background for IE Core.
  • Conformance: These pages describe the set of rules to claim conformance to this guide
    • General Requirements: This page defines requirements common to all actors and profiles used in this guide, including how CapabilityStatements are used to claim conformance.
    • Must Support: This page defines the expectations for mandatory and Must Support elements in the IE Core Profiles.
  • Guidance: The Guidance pages document best practices and how to use the profiles and transactions defined in this guide.
    • IECDI: This page maps the IE Core Profiles to the (IECDI) data classes and data elements.
    • General Guidance: This page provides guidance, definitions, and requirements common to all actors and profiles used in this guide.
    • Clinical Notes: This page provides guidance on the interactions between Consumers and Producers of clinical notes.
    • Medication List: This page provides guidance on how a patient or provider can access a patient's medications.
    • Basic Provenance: This page provides implementers with important definitions to create and share the Provenance Resource.
    • Screening and Assessments: This page documents how IE Core Profiles are used to represent screenings and assessments for patient health status
    • Future of IE Core: This page outlines the approach to adding new content to IE Core.
  • FHIR Artifacts: These pages provide detailed descriptions and formal definitions for all the FHIR objects defined in this guide.
    • Profiles and Extensions: This page lists the IE Core Profiles and Extensions defined in this guide to exchange quality data.
      • Each IE Core Profile page includes a narrative description that lists all the Mandatory and Must Support data elements, profile-specific implementation guidance, and formal definitions. A "Quick Start" guide summarizes the supported search transactions for each profile. Although the guidance typically focuses on the profiled elements, it also may cover un-profiled elements to aid with implementation and certification.
    • Search Parameters and Operations: This page lists the defined IE Core Operations and Search Parameters used in IE Core transactions.
    • Terminology: This page lists the IE Core ValueSets, and CodeSystems defined for the profiles.
    • Capability Statements: These pages define the expected FHIR capabilities of the IE Core Servers and Clients.
  • Security: This page documents the general security requirements and recommendations for actors.
  • Examples: This page lists all the examples used in this guide. These examples show what data produced and consumed by systems conforming with this implementation guide might look like. Every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification, nor fully representative of real-world examples.
  • Downloads: This page provides links to downloadable artifacts.
  • Change Log: This page documents the changes across the versions of IE Core

IE Core Actors

The following actors are part of the IE Core IG:

IE Core Requestor

A IE Core Requester is an application that initiates a data access request to retrieve patient data. The IE Core Requestor is the client in a client-server interaction. The terms "IE Core Requestor" and "Client" are used interchangeably throughout this guide and are not meant to limit this actor to only patient and provider apps. For example, payers and other users can use the same technology. These terms are a short-hand notation for "user application".

IE Core Responder

A IE Core Responder is a system that responds to the data access request providing patient data. The IE Core responder is the server in a client-server interaction. The terms "IE Core Responder", "Server", and "EHR" are used interchangeably throughout this guide and are not meant to limit this actor to electronic health record systems. For example, HIEs, care coordination platforms, population health systems, etc., can use the same technology. These terms are a short-hand notation for "interoperable healthcare platform".

IE Core Profiles

Below is the list of IE Core Profiles. Each profile identifies which core elements, extensions, vocabularies, and ValueSets SHALL be present in the resource when using this profile. Together, they promote interoperability and adoption through common implementation and provide the floor for standards development for specific use cases. See the IECDI page, for a mapping to the iEHR IE Core Data for Interoperability (IECDI).

A simple narrative summary gives each profile's requirements and guidance. A formal hierarchical table presents a logical view of the content in both a differential and snapshot view, and provides references to appropriate terminologies and examples.

AllergyIntolerance

CarePlan

CareTeam

Condition

Coverage

Device

DiagnosticReport

DocumentReference

Encounter

Goal

Identifier

Immunization

Location

Medication

MedicationDispense

MedicationRequest

Observation

Organization

Patient

Practitioner

PractitionerRole

Procedure

Provenance

QuestionnaireResponse

RelatedPerson

ServiceRequest

Specimen

IE Core FHIR RESTful interactions

For systems that support the IE Core Profile content structure and the RESTful interactions defined for a resource, the requirements are formally defined in the IE Core CapabilityStatements. In addition, each profile page has a Quick Start Section that documents the required FHIR RESTful search and read operations. These sections demonstrate how to access a patient's clinical and administrative data:

Example of a simple FHIR RESTful Search Transaction
basic_fhir_restful_interaction.svg

See the FHIR specification for details on FHIR RESTful Search API and the SMART App Launch for how an application gets access to a patient record.

License

HL7® is a registered trademark of Health Level Seven (HL7), Inc., the non-profit standards developing organization that is accredited by the American National Standards Institute (ANSI).

FHIR®© is a registered trademark of HL7.

SNOMED® is a registered trademark of the International Health Terminology Standards Development Organisation.

LOINC® is a registered trademark of Regenstrief Institute, Inc.