FHIR profile validations for HealthLake - AWS HealthLake
Validating FHIR profiles specified in a resource

FHIR profile validations for HealthLake

AWS HealthLake supports the base FHIR R4 specification. Included in the base FHIR R4 specification are FHIR Profiles. Profiles are used on a FHIR resource type to define a more specific resource type definition using constraints and/or extensions on the base resource type. For example, a FHIR Profile can identify mandatory fields such as extensions and value sets. A resource can support multiple profiles. All HealthLake data stores support using FHIR Profiles.

Note

Adding a FHIR profile is not required when adding data to a HealthLake data store. If a FHIR profile is not specified when a resource is added or updated, the resource is validated against only the base FHIR R4 schema.

FHIR profiles, to which FHIR resources conform to, are included in resources before they are imported into HealthLake. Therefore, FHIR profiles are validated by HealthLake during import.

FHIR Profiles are specified in an implementation guide. A FHIR Implementation Guide (IG) is a set of instructions that describe how to use the FHIR standard for a specific purpose. HealthLake validates FHIR Profiles defined in the following implementation guides.

FHIR profiles supported by AWS HealthLake
Name Version Implementation guide Capability
US Core

3.1.1

 http://hl7.org/fhir/us/core/STU3.1.1/ Default
US Core

4.0.0

 https://hl7.org/fhir/us/core/STU4/index.html Supported
CARIN Blue Button 1.1.0 http://hl7.org/fhir/us/carin-bb/STU1.1/ Default
CARIN Blue Button 1.0.0 https://hl7.org/fhir/us/carin-bb/STU1/ Supported
Da Vinci Payer Data Exchange

1.0.0

 https://hl7.org/fhir/us/davinci-pdex/ Default
Da Vinci Health Record Exchange (HRex)

0.2.0

 https://hl7.org/fhir/us/davinci-hrex/2020Sep/ Default
DaVinci PDEX Plan Net

1.1.0

 https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.1/ Default
DaVinci PDEX Plan Net

1.0.0

 https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1/ Supported
DaVinci Payer Data Exchange (PDex) US Drug Formulary

1.1.0

 https://hl7.org/fhir/us/davinci-drug-formulary/STU1.1/ Default
DaVinci Payer Data Exchange (PDex) US Drug Formulary

1.0.1

 https://hl7.org/fhir/us/davinci-drug-formulary/STU1.0.1/ Supported

National Health Authority's Ayushman Bharat Digital Mission (ABDM)

 2.0 https://www.nrces.in/ndhm/fhir/r4/index.html Default

Validating FHIR profiles specified in a resource

For a FHIR Profile to be validated add it to the profile element of individual resources using the profile URL designated in the implementation guide.

FHIR Profiles are validated when you add a new resource to your data store. To add a new resource, you can use the StartFHIRImportJob API operation, make a POST request to add a new resource, or make PUT to update an existing resource.

Example – To see which FHIR profile is referenced in a resource

The profile URL is added to the profile element in the "meta" : "profile" key-value pair. This resource was truncated for clarity. 

{
    "resourceType": "Patient",
    "id": "abcd1234efgh5678hijk9012",
    "meta": {
        "lastUpdated": "2023-05-30T00:48:07.8443764-07:00",
        "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
        ]
    }
}
Example – How to reference a non-default supported FHIR profile

To validate against a supported non-default profile (e.g. CarinBB 1.0.0) - add the profile URL with version (separated by '|') and the base profile URL in the meta.profile element. This example resource was truncated for clarity. 

{
    "resourceType": "ExplanationOfBenefit",
    "id": "sample-EOB",
    "meta": {
        "lastUpdated": "2024-02-02T05:56:09.4+00:00",
        "profile": [
            "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy|1.0.0",
      "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy“
        ]
    }
}