FHIR Implementation Guide for ABDM
3.1.0 - active India flag

Banner

FHIR Implementation Guide for ABDM - Local Development build (v3.1.0). See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

StructureDefinition/AllergyIntolerance

This profile sets minimum expectations for the AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient.

StructureDefinition/Appointment

This profile sets minimum expectations for the Appointment resource to searching for and fetching information about a booking of a healthcare event among patient(s), practitioner(s), related person(s), and/or device(s) for a specific date/time for a patient.

StructureDefinition/Binary

This profile sets minimum expectations for the Binary resource to searching for and fetching the data of a single raw artifact as digital content accessible in its native format of a patient.

StructureDefinition/CarePlan

This profile sets minimum expectations for the CarePlan resource to record, search, and fetch assessment and plan of treatment data associated with a patient.

StructureDefinition/Claim

This profile sets minimum expectations for the providers and payors, insurers, to exchange the financial information, and supporting clinical information.

StructureDefinition/ClaimBundle

The profile is based on a Bundle of type collection, where all the supporting information required for processing claim can be shared. Multiple entries can be added in a bundle to provide information like financial, clinical, provision of health care services with payors and for reporting to regulatory bodies and firms which provide data analytics. The bundle can be generated depending on the nature of the request defined by ‘use’ element in a claim resource, like preauthorization, predetermination and claim and can be shared over NHCX ecosystem.

StructureDefinition/ClaimResponse

This profile represents application level adjudication outcomes, or an application level error, that occur as a result of processing a supplied Claim resource, which could be a functional corollary of a Claim, Predetermination, or Preauthorization.

StructureDefinition/ClaimResponseBundle

The profile is based on a Bundle of type collection, where adjudicated response to a Claim, Predetermination or Preauthorization related information is carried. Multiple entries included in a bundle carries the information and provides application level adjudication results.

StructureDefinition/Communication

This profile sets the minimum requirement for documenting any communication, whether it is planned or unsuccessful. A communication refers to the exchange of information from a sender to a receiver, and these entities can encompass patients, practitioners, related individuals, organizations, or devices. The resource serves as a record of these interactions.

StructureDefinition/CommunicationRequest

This profile sets the minimum requirement for a communication to be carried out, serving as a record of the communication request. In this context, a communication refers to the transmission of information from a sender to a receiver. The requester initiates the communication by asking the sender to convey the payload to the intended recipient. The sender and receivers involved in this process can encompass patients, practitioners, related persons, organizations, and devices.

StructureDefinition/Condition

This profile sets minimum expectations for the Condition resource to record, search, and fetch a list of conditions associated with a patient.

StructureDefinition/Coverage

This profile aims to capture essential identifiers and descriptors of an insurance plan through the Coverage resource. It encompasses information that is typically found on an insurance card and can be utilized to cover the costs, either partially or entirely, for healthcare products and services.

StructureDefinition/CoverageEligibilityRequest

This profile sets minimum expectations for CoverageEligibilityRequest to provide patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

StructureDefinition/CoverageEligibilityRequestBundle

The profile is based on a Bundle of type collection, where all the information required to process Coverage Eligibility Request can be shared. Depending on the purpose of the request like validation, discovery,auth-requirement and benefit data can be included in the etries of a bundle.

StructureDefinition/CoverageEligibilityResponse

This profile provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

StructureDefinition/CoverageEligibilityResponseBundle

The Coverage Eligibility Response Bundle is a Bundle profile with type collection. The bundle profile provides the response and plan details from the processing of an CoverageEligibilityRequest resource.

StructureDefinition/DiagnosticReportImaging

This profile represents the set of information related to the Imaging diagnosis report generated by imaging services like Radiology, Cardiology, Endoscopy, etc. are ordered for the patient.

StructureDefinition/DiagnosticReportImaging

This profile represents the set of information related to the Laboratory diagnosis report generated by the laboratory services like Complete Blood Count, Basic Metabolic Panel, Lipid Panel, Urinalysis, etc. are ordered for the patient.

StructureDefinition/DiagnosticReportRecord

The Clinical Artifact represents diagnostic reports including Radiology and Laboratory reports that can be shared across the health ecosystem.

StructureDefinition/DischargeSummaryRecord

Clinical document used to represent the discharge summary record for ABDM HDE data set.

StructureDefinition/DocumentBundle

This profile sets minimum expectations for the DocumentBundle that includes all resources into a single instance with containing context to act as an exchangeable clinical document.

StructureDefinition/DocumentReference

This profile sets minimum expectations for searching and fetching patient documents including the Clinical Notes using the DocumentReference resource.

StructureDefinition/Encounter

This profile sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient.

StructureDefinition/FamilyMemberHistory

This profile sets minimum expectations for the FamilyMemberHistory resource for searching and fetching significant health conditions of a person related to the patient in the context of care.

StructureDefinition/HealthDocumentRecord

The Clinical Artifact represents the unstructured historical health records as a single of multiple Health Record Documents generally uploaded by the patients through the Health Locker and can be shared across the health ecosystem.

StructureDefinition/ImagingStudy

This profile sets minimum expectations for the ImagingStudy resource to searching for and fetching the content produced in a DICOM imaging study.

StructureDefinition/Immunization

This profile sets minimum expectations for the Immunization resource to record, fetch and search immunization history associated with a patient.

StructureDefinition/ImmunizationRecommendation

This profile sets minimum expectations for the ImmunizationRecommendation resource to support the next immunization to be taken by the patient.

StructureDefinition/ImmunizationRecord

The Clinical Artifact represents the Immunization records with any additional documents such as vaccine certificate, the next immunization recommendations, etc. This can be further shared across the health ecosystem.

StructureDefinition/InsurancePlan

This Profile describes a health insurance offering comprised of a list of covered benefits (i.e. the product), costs associated with those benefits (i.e. the plan), and additional information about the offering, such as who it is owned and administered by, a coverage area, contact information, etc.

StructureDefinition/InsurancePlanBundle

This profile is based on a Bundle of type collection, providing a description of a health insurance package that consists of a comprehensive list of covered benefits (referred to as the product), associated costs (known as the plan), and supplementary details regarding the offering, such as ownership and administration, coverage area, contact information, and more.

StructureDefinition/Media

This profile sets minimum expectations for the Media resource to searching for and fetching media like a photo, video, or audio recording acquired or used in healthcare, associated with a patient or provider.

StructureDefinition/MedicationRequest

The MedicationRequest resource can be used to record a patient’s medication prescription or order. This profile sets minimum expectations for the MedicationRequest resource to record, search, and fetch medications associated with a patient.

StructureDefinition/MedicationStatement

The MedicationStatement resource can be used to record a patient’s medication information. It is used to record the information about the medications consumed by the patient in the past, present, or future.

StructureDefinition/OPConsultRecord

The Clinical Artifact represents the outpatient visit consultation note which may include clinical information on any OP examinations, procedures along with medication administered, and advice that can be shared across the health ecosystem.

StructureDefinition/Observation

Observation resource represents an individual laboratory test and result value, a “nested” panel (such as a microbial susceptibility panel) which references other observations, or rarely a laboratory test with component result values. This profile sets minimum expectations for the Observation resource to record, search, and fetch laboratory test results associated with a patient.

StructureDefinition/ObservationBodyMeasurement

This profile sets minimum expectations for the ObservationBodyMeasurement to record, search, and fetch the details of the body measurements of the patient.

StructureDefinition/ObservationGeneralAssessment

This profile sets minimum expectations for the ObservationGeneralAssessment to record, search, and fetch the details of the general health assessment of a patient.

StructureDefinition/ObservationLifestyle

This profile sets minimum expectations for the ObservationLifestyle to record, search, and fetch the details of the lifestyle of the patient.

StructureDefinition/ObservationPhysicalActivity

This profile sets minimum expectations for the ObservationPhysicalActivity to record, search, and fetch the details of the physical activities of a patient.

StructureDefinition/ObservationVitalSigns

This profile sets minimum expectations for the ObservationVitalSigns to record, search, and fetch the details of the vital signs of a patient.

StructureDefinition/ObservationWomenHealth

This profile sets minimum expectations for ObservationWomenHealth to record, search, and fetch the details of women’s health.

StructureDefinition/Organization

This profile sets minimum expectations for the Organization resource to searching for and fetching an Organization associated with a patient or provider.

StructureDefinition/Patient

This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient.

StructureDefinition/PaymentNotice

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

StructureDefinition/PaymentReconciliation

This profile provides the bulk payment details associated with a payment for goods and services rendered by a provider to patients covered by insurance plans offered by that payor.

StructureDefinition/Practitioner

This profile sets minimum expectations for the Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner.

StructureDefinition/PractitionerRole

This profile sets minimum expectations for the PractitionerRole resource to record, search, and fetch the practitioner role for a practitioner.

StructureDefinition/PrescriptionRecord

The Clinical Artifact represents the medication advice to the patient in compliance with the Pharmacy Council of India (PCI) guidelines, which can be shared across the health ecosystem.

StructureDefinition/Procedure

This profile sets minimum expectations for the Procedure resource to record, search, and fetch procedures associated with a patient.

StructureDefinition/ServiceRequest

This profile sets minimum expectations for the ServiceRequest resource to searching for and fetching information about services like a request for a procedure or diagnostic or other services to be planned, proposed, or performed associated with a patient or provider.

StructureDefinition/Specimen

This profile sets minimum expectations for the Specimen resource to searching for and fetching information regarding a sample to be used for the analysis of a patient.

StructureDefinition/Task

This profile describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.

StructureDefinition/WellnessRecord

The Clinical Artifact represents regular wellness information of patients typically through the Patient Health Record (PHR) application covering clinical information such as vitals, physical examination, general wellness, women wellness, etc., that can be shared across the health ecosystem.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

StructureDefinition/BrandName

This Extention sets minimum expectations for the Brandname element to searching for and fetching a Brandname associated with vaccine.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Alcohol Drinking Status

This value set covers : All children (preferred term) of finding relating to alcohol drinking behavior (finding) of the SNOMED CT

Benefit Category

This Valueset includes a collection of SNOMEDCT codes related to BenefitCategory.

Benefit Type

This ValueSet includes a collection of codes that can be used to categorize the type of benefits provided by an insurance.

Body Measurement

This value set covers LOINC Codes for Body Measurement

Care Team Qualification

This valueset comprises codes that represent credentials or specializations of healthcare practitioners.

Care Team Role

This valueset comprises codes that represent various roles within a care team.

Claim Type

This ValueSet contains a set of codes that can be utilized to state the type of Claim.

Coverage Type

This ValueSet consists of a set of codes that can be utilized to categorize the insurance coverage type.

Diagnosis Use

This value set contains a set of SNOMED CT codes for Diagnosis type

Diagnostic Report Type

The Diagnostic Report Type Value Set is a set of types supported for Diagnostic Reports and notes.

Diagnostic Type

This valueset contains codes that represent the various types of diagnoses.

Diet Type

This value set covers : All children (preferred term) of finding relating to Dietary finding (finding) of the SNOMED CT

EncounterTypes

This value set includes codes from SNOMED CT

General Assessment

This value set covers LOINC and SNOMED CT Codes for General Assessment

General Wellbeing

This value set covers : All children (preferred term) of General well-being finding (finding) of the SNOMED CT

ICD10 Diagnostic codes

This valueset consists of codes that represent ICD-10 Diagnostic codes.

Identifier Type Code

This Valueset contains coded type for an identifier that can be used to determine which identifier to use for a specific purpose

InsurancePlan Type

This Valueset is composed of codes that are used to classify the various types of InsurancePlans.

Lifestyle

This value set covers SNOMEDCT Codes for type of Lifestyle

Medicine Codes

This Value Set covers: Clinical Drugs from SNOMED CT International Edition, Clinical Drugs and Branded Medicines (Real Clinical Drugs) from Common Drug Codes for India (National Extension). For more information refer: https://www.nrces.in/services/national-releases

Mental Status

This value set covers : All children (preferred term) of finding relating to Emotional state finding (finding) of the SNOMED CT

Physical Activity

This value set covers LOINC Codes for Physical Activity

Plan Type

This ValueSet contains a set of codes that can be utilized to categorize the type of insurance plans.

Practitioner Role

This value set defines a set of codes that can be used to indicate the role of a Practitioner.

ProductorService

This value set includes codes for product or service from SNOMEDCT

Program Code

This Valueset contains set of codes that can be used to classify groupings of service-types/specialties.

Route Of Administration

This value set contains a set of SNOMED CT codes for Route Of Administration

Specimen Types

This value set contains a set of SNOMED CT codes for Specimen Types

SupportingInfo Category

This Valueset contains classification of the information supplied for the processing of different workflows like claims etc.

SupportingInfo Code

This Valueset contains code pertaining to the specific information mentioned with the category of supporting info.

Tobacco Chewing Status

This value set covers : All children (preferred term) of Finding relating to tobacco chewing of the SNOMED CT

Tobacco Smoking Status

This value set covers : All children (preferred term) of Finding relating to tobacco smoking behavior (finding) of the SNOMED CT

Vaccine Codes

This value set covers : All leaf nodes (preferred term) of children of Vaccine product containing bacteria antigen (medicinal product) and Vaccine product containing virus antigen (medicinal product) of the SNOMED CT

Vital Signs

This value set covers LOINC Codes for Vital Signs

Women Health

This value set covers LOINC Codes for Women Health

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Benefit Type

This CodeSystem includes a collection of codes that can be used to categorize the type of benefits provided by an insurance.

Coverage Type

This CodeSystem consists of a set of codes that can be utilized to categorize the insurance coverage type.

Identifier Type Code

This CodeSystem contains coded type for an identifier that can be used to determine which identifier to use for a specific purpose

InsurancePlan Type

This CodeSystem is composed of codes that are used to classify the various types of InsurancePlans.

Plan Type

This CodeSystem contains a set of codes that can be utilized to categorize the type of insurance plans.

Program Code

This CodeSystem contains set of codes that can be used to classify groupings of service-types/specialties

SupportingInfo Category

This CodeSystem contains classification of the information supplied for the processing of different workflows like claims etc.

SupportingInfo code

This CodeSystem contains code pertaining to the specific information mentioned with the category of supporting info

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

AllergyIntolerance/example-01

AllergyIntolerance/example-01

Appointment/example-01

Appointment/example-01

Binary/example-01

Binary/example-01

CarePlan/example-01

CarePlan/example-01

Claim/example-01

Claim/example-01

ClaimBundle-example-01

ClaimBundle-example-01

ClaimBundle-preauth-example-01

ClaimBundle-preauth-example-01

ClaimResponse/example-01

ClaimResponse/example-01

ClaimResponseBundle-example-01

ClaimResponseBundle-example-01

Condition/example-01

Condition/example-01

Coverage/example-01

Coverage/example-01

CoverageEligibilityRequest/benefit-example-01

CoverageEligibilityRequest/benefit-example-01

CoverageEligibilityRequest/discovery-example-01

CoverageEligibilityRequest/discovery-example-01

CoverageEligibilityRequest/preauth-example-01

CoverageEligibilityRequest/preauth-example-01

CoverageEligibilityRequest/validation-example-01

CoverageEligibilityRequest/validation-example-01

CoverageEligibilityRequestBundle-auth-requirement-example-01

CoverageEligibilityRequestBundle-auth-requirement-example-01

CoverageEligibilityRequestBundle-benefit-example-01

CoverageEligibilityRequestBundle-benefit-example-01

CoverageEligibilityRequestBundle-discovery-example-01

CoverageEligibilityRequestBundle-discovery-example-01

CoverageEligibilityRequestBundle-validation-example-01

CoverageEligibilityRequestBundle-validation-example-01

CoverageEligibilityResponse/benefit-example-01

CoverageEligibilityResponse/benefit-example-01

CoverageEligibilityResponse/preauth-example-01

CoverageEligibilityResponse/preauth-example-01

CoverageEligibilityResponse/preauth-example-01

CoverageEligibilityResponse/preauth-example-01

CoverageEligibilityResponse/validation-example-01

CoverageEligibilityResponse/validation-example-01

CoverageEligibilityResponseBundle-auth-requirements-example-01

CoverageEligibilityResponseBundle-auth-requirements-example-01

CoverageEligibilityResponseBundle-benefit-example-01

CoverageEligibilityResponseBundle-benefit-example-01

CoverageEligibilityResponseBundle-discovery-example-01

CoverageEligibilityResponseBundle-discovery-example-01

CoverageEligibilityResponseBundle-validation-example-01

CoverageEligibilityResponseBundle-validation-example-01

DiagnosticReport-Imaging-DCM-example-01

DiagnosticReport-Imaging-DCM-example-01

DiagnosticReport-Imaging-Media-example-02

DiagnosticReport-Imaging-Media-example-02

DiagnosticReport-Lab-example-03

DiagnosticReport-Lab-example-03

DiagnosticReport/ImagingDCM-example-02

DiagnosticReport/ImagingDCM-example-02

DiagnosticReport/ImagingMedia-example-03

DiagnosticReport/ImagingMedia-example-03

DiagnosticReport/Lab-example-01

DiagnosticReport/Lab-example-01

DischargeSummary-example-04

DischargeSummary-example-04

DocumentReference/example-01

DocumentReference/example-01

Encounter/example-01

Encounter/example-01

FamilyMemberHistory/example-01

FamilyMemberHistory/example-01

HealthDocumentRecord-example-01

HealthDocumentRecord-example-01

ImagingStudy/example-01

ImagingStudy/example-01

Immunization/example-01

Immunization/example-01

Immunization/example-WHO-DDCC

Immunization/example-WHO-DDCC

ImmunizationRecommendation/example-01

ImmunizationRecommendation/example-01

ImmunizationRecord-example-07

ImmunizationRecord-example-07

ImmunizationRecord-for-WHO-DDCC

ImmunizationRecord-for-WHO-DDCC

InsurancePlan-example-01

InsurancePlan-example-01

InsurancePlanBundle-example-01

InsurancePlanBundle-example-01

Location-example-01

Location-example-01

Location/example-01

Location/example-01

Media/example-01

Media/example-01

MedicationRequest/example-01

MedicationRequest/example-01

MedicationStatement/example-01

MedicationStatement/example-01

OPConsultNote-example-05

OPConsultNote-example-05

Observation-finding-example-01

Observation-finding-example-01

Observation-lab-example-01

observation lab example

Observation-lab-example-03

Observation-lab-example-03

Observation-lab-example-04

Observation-lab-example-04

Observation-lab-example-05

Observation-lab-example-05

Observation-lab-example-06

Observation-lab-example-06

Observation-lab-example-07

Observation-lab-example-07

Observation-lab-example-08

Observation-lab-example-08

Observation-lab-example-09

Observation-lab-example-09

Observation-lab-example-10

Observation-lab-example-10

Observation-lab-example-11

Observation-lab-example-11

Observation-lab-example-12

Observation-lab-example-12

Observation-lab-example-13

Observation-lab-example-13

Observation-lab-example-14

Observation-lab-example-14

Observation/example-15

Observation/example-15

Observation/example-16

Observation/example-16

Observation/example-17

Observation/example-17

Observation/example-18

Observation/example-18

Observation/example-19

Observation/example-19

Observation/example-20

Observation/example-20

Observation/example-21

Observation/example-21

Observation/example-22

Observation/example-22

Observation/example-23

Observation/example-23

Observation/example-24

Observation/example-24

Observation/example-25

Observation/example-25

Observation/example-26

Observation/example-26

Observation/example-27

Observation/example-27

Observation/example-28

Observation/example-28

Observation/example-29

Observation/example-29

Observation/example-30

Observation/example-30

Observation/example-31

Observation/example-31

Observation/example-32

Observation/example-32

Observation/example-33

Observation/example-33

Observation/example-34

Observation/example-34

Observation/example-35

Observation/example-35

Observation/example-36

Observation/example-36

Organization-example-03

Organization-example-03

Organization/example-01

Organization/example-01

Patient/example-01

Patient/example-01

PaymentNotice/example-01

PaymentNotice/example-01

PaymentReconciliation/example-01

PaymentReconciliation/example-01

Practitioner/example-01

Practitioner/example-01

PractitionerRole/example-01

PractitionerRole/example-01

Prescription-example-06

Prescription-example-06

Procedure/example-01

Procedure/example-01

ServiceRequest/example-01

ServiceRequest/example-01

Specimen/example-01

Specimen/example-01

WellnessRecord-example-01

WellnessRecord-example-01