MyHealth summary from Patient/$everything

Note that MyHealth is available only in the test and QA environments. It is not available in production. Changes might therefore occur.

An authorized client can request a MyHealth@EU Patient Summary through the existing Patient Everything endpoint.

Request

Use the query parameter representation=myhealth. The value is case-insensitive. Both requests below require clients to be authorized.

Test:

GET https://critical-information.hit.test.nhn.no/api/critical-information/v1/Patient/$everything?representation=myhealth
Accept: application/fhir+json

QA:

GET https://qa.critical-information.hit.nhn.no/api/critical-information/v1/Patient/$everything?representation=myhealth
Accept: application/fhir+json

A successful request returns HTTP 200 with a FHIR R4 JSON Bundle.

Omitting the representation paramenter retains the existing FHIR JSON searchset Bundle in every environment.

See Error Handling for the error conventions.

Included information

Currently only MyHealthAllergyIntolerance is supported. See that document for included records, field mappings, terminology and examples.

Deleted records are excluded.

Profiles and document structure

The payload uses ordinary FHIR R4 resources. The adopted baseline is FHIR R4 4.0.1, with the following profiles:

The service-author Device uses the base R4 Device resource. The compatible package set is pinned rather than selected from the latest build:

Use the profile versions listed above when validating a response.

Reading the document

The response is one FHIR document. Its first entry is a Composition, which describes the summary and links to its contents. The remaining entries contain the patient, clinical resources, and supporting information about the service and health professionals who supplied the information.

To find the clinical resources, follow the Composition sections' entry.reference values. Match each reference to a Bundle.entry.fullUrl. The Composition's subject identifies the patient in the document.

Document references use urn:uuid:... values. The patient's national identification number is in Patient.identifier, with system urn:oid:2.16.578.1.12.4.1.4.1. Patient.id identifies the patient resource within this document. A reference beginning with # points to a resource in the containing resource's contained array.

The Device referenced by Composition.author identifies the service that generated the summary. It does not describe a medical device used by the patient.

Sections and missing information

The MyHealth profile requires LOINC codes (http://loinc.org) to identify the document type and sections. Composition.type uses 60591-5 for a patient summary. The service adds these codes when assembling the document.

The Composition always contains these five sections:

The four unsupported sections contain the text Information not supplied in this version and emptyReason=notasked. This describes the API's coverage, even when those records exist in the default Patient Everything response. It does not mean that the patient has no such records.

Patient and document metadata

Patient information is limited to the national identification number and, when available, the birth year. A value such as birthDate: "1960" has year-only precision; no month or day is supplied.

The patient's name is always marked as unknown. If the birth year is unavailable, it is marked as unknown using the standard FHIR data-absent-reason extension. For example, the following Patient fragment has neither a name value nor a birth-date value:

{
  "name": [
    {
      "_text": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "unknown"
          }
        ]
      }
    }
  ],
  "_birthDate": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    ]
  }
}

Each response has a new Bundle.identifier and a separate Composition.identifier. Bundle.timestamp and Composition.date describe when the summary was generated.

The Composition has status preliminary, language no-NO, and title Pasientoppsummering – allergier og intoleranser. Its author identifies the generating service.

Complete response examples

The example uses synthetic patient, resource, professional, and organisation identifiers. It illustrates the response structure; document identifiers and generation times vary between requests.

Successful document with an eligible allergy

{
  "resourceType": "Bundle",
  "meta": {
    "profile": [
      "http://fhir.ehdsi.eu/eps/StructureDefinition/bundle-eps-myhealtheu"
    ]
  },
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:uuid:a0000000-0000-4000-a000-000000000001"
  },
  "type": "document",
  "timestamp": "2026-11-05T12:00:00.123Z",
  "entry": [
    {
      "fullUrl": "urn:uuid:a0000000-0000-4000-a000-000000000002",
      "resource": {
        "resourceType": "Composition",
        "id": "a0000000-0000-4000-a000-000000000002",
        "meta": {
          "profile": [
            "http://fhir.ehdsi.eu/eps/StructureDefinition/composition-eps-myhealtheu"
          ]
        },
        "language": "no-NO",
        "identifier": {
          "system": "urn:ietf:rfc:3986",
          "value": "urn:uuid:a0000000-0000-4000-a000-000000000003"
        },
        "status": "preliminary",
        "type": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "60591-5"
            }
          ]
        },
        "subject": {
          "reference": "urn:uuid:a0000000-0000-4000-a000-000000000004"
        },
        "date": "2026-11-05T12:00:00.123Z",
        "author": [
          {
            "reference": "urn:uuid:a0000000-0000-4000-a000-000000000005"
          }
        ],
        "title": "Pasientoppsummering – allergier og intoleranser",
        "section": [
          {
            "title": "Allergies",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "48765-2"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Allergies and intolerances</div>"
            },
            "entry": [
              {
                "reference": "urn:uuid:a0000000-0000-4000-a000-000000000006"
              }
            ]
          },
          {
            "title": "Problems",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "11450-4"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Information not supplied in this version</div>"
            },
            "emptyReason": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/list-empty-reason",
                  "code": "notasked"
                }
              ]
            }
          },
          {
            "title": "Medications",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "10160-0"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Information not supplied in this version</div>"
            },
            "emptyReason": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/list-empty-reason",
                  "code": "notasked"
                }
              ]
            }
          },
          {
            "title": "History of Procedures",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "47519-4"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Information not supplied in this version</div>"
            },
            "emptyReason": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/list-empty-reason",
                  "code": "notasked"
                }
              ]
            }
          },
          {
            "title": "Medical Devices",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "46264-8"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Information not supplied in this version</div>"
            },
            "emptyReason": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/list-empty-reason",
                  "code": "notasked"
                }
              ]
            }
          }
        ]
      }
    },
    {
      "fullUrl": "urn:uuid:a0000000-0000-4000-a000-000000000004",
      "resource": {
        "resourceType": "Patient",
        "id": "a0000000-0000-4000-a000-000000000004",
        "meta": {
          "profile": [
            "http://fhir.ehdsi.eu/eps/StructureDefinition/patient-myhealtheu-eps"
          ]
        },
        "identifier": [
          {
            "system": "urn:oid:2.16.578.1.12.4.1.4.1",
            "value": "00000000000"
          }
        ],
        "name": [
          {
            "_text": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                  "valueCode": "unknown"
                }
              ]
            }
          }
        ],
        "birthDate": "1960"
      }
    },
    {
      "fullUrl": "urn:uuid:a0000000-0000-4000-a000-000000000005",
      "resource": {
        "resourceType": "Device",
        "id": "a0000000-0000-4000-a000-000000000005",
        "deviceName": [
          {
            "name": "critical-information",
            "type": "user-friendly-name"
          }
        ]
      }
    },
    {
      "fullUrl": "urn:uuid:a0000000-0000-4000-a000-000000000006",
      "resource": {
        "resourceType": "AllergyIntolerance",
        "id": "a0000000-0000-4000-a000-000000000006",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-04-06T15:19:01.355+02:00",
          "profile": [
            "http://fhir.ehdsi.eu/eps/StructureDefinition/allergyIntolerance-eps-myhealtheu"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "unconfirmed",
              "display": "Unconfirmed"
            }
          ]
        },
        "category": [
          "medication"
        ],
        "criticality": "high",
        "code": {
          "coding": [
            {
              "system": "http://nhn.no/kj/fhir/CodeSystem/DrugTradeName",
              "code": "ID_D31A34B4-705F-44D6-8232-92A89CA921B1",
              "display": "Apocillin Tab 660 mg",
              "userSelected": true
            },
            {
              "system": "http://www.whocc.no/atc",
              "code": "J01CE02",
              "userSelected": false
            }
          ]
        },
        "patient": {
          "reference": "urn:uuid:a0000000-0000-4000-a000-000000000004"
        },
        "onsetDateTime": "2021-04-01T00:00:00+02:00",
        "recordedDate": "2021-04-06T15:19:01+02:00",
        "recorder": {
          "reference": "urn:uuid:a0000000-0000-4000-a000-000000000007"
        },
        "note": [
          {
            "text": "Fikk eksematøse reaksjoner som ble behandlet med lokale glukokortikoider pluss antihistaminer for behandling av urtikarielle reaksjoner."
          },
          {
            "text": "The reaction is recorded as an excipient reaction (a reaction to an inactive ingredient in the medicine)."
          }
        ],
        "reaction": [
          {
            "manifestation": [
              {
                "coding": [
                  {
                    "system": "http://nhn.no/kj/fhir/CodeSystem/TypeOfReaction",
                    "code": "10",
                    "display": "Alvorlig hudreaksjon",
                    "userSelected": true
                  },
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                    "code": "UNC",
                    "userSelected": false
                  }
                ]
              }
            ]
          }
        ],
        "language": "no-NO"
      }
    },
    {
      "fullUrl": "urn:uuid:a0000000-0000-4000-a000-000000000007",
      "resource": {
        "resourceType": "PractitionerRole",
        "id": "a0000000-0000-4000-a000-000000000007",
        "practitioner": {
          "reference": "urn:uuid:a0000000-0000-4000-a000-000000000008"
        },
        "organization": {
          "reference": "urn:uuid:a0000000-0000-4000-a000-000000000009"
        },
        "code": [
          {
            "coding": [
              {
                "system": "http://nhn.no/kj/fhir/CodeSystem/CategoriesOfHealthProfessionals",
                "code": "LE",
                "display": "Lege"
              }
            ]
          }
        ],
        "meta": {
          "profile": [
            "http://hl7.eu/fhir/base/StructureDefinition/practitionerRole-eu-core"
          ]
        }
      }
    },
    {
      "fullUrl": "urn:uuid:a0000000-0000-4000-a000-000000000008",
      "resource": {
        "resourceType": "Practitioner",
        "id": "a0000000-0000-4000-a000-000000000008",
        "meta": {
          "profile": [
            "http://hl7.eu/fhir/base/StructureDefinition/practitioner-eu-core"
          ]
        },
        "identifier": [
          {
            "system": "urn:oid:2.16.578.1.12.4.1.4.4",
            "value": "900000001"
          }
        ],
        "name": [
          {
            "text": "EKSEMPEL LEGE"
          }
        ]
      }
    },
    {
      "fullUrl": "urn:uuid:a0000000-0000-4000-a000-000000000009",
      "resource": {
        "resourceType": "Organization",
        "id": "a0000000-0000-4000-a000-000000000009",
        "meta": {
          "profile": [
            "http://hl7.eu/fhir/base/StructureDefinition/organization-eu-core"
          ]
        },
        "identifier": [
          {
            "system": "urn:oid:2.16.578.1.12.4.1.4.101",
            "value": "999999999"
          }
        ],
        "name": "Eksempel legekontor"
      }
    }
  ]
}