Capabilities: Aggregated Endpoint

By Andrew Turner (Unlicensed)
2 min

Data Sources

  • Non-FHIR Data

    • Patients, professionals, or carers enter data manually in PKB.

    • Customers and partners send data to PKB using non-FHIR APIs (e.g., HL7 / Custom REST / Facade APIs).

    • If available in the Aggregated API, this data will conform to the PKB Aggregated profile for that particular resource.

    • Some of the FHIR resource data types cannot be added to PKB in a non-FHIR format, so these are marked as Not applicable ('N/A').

  • FHIR Data

    • Customers and partners send data to PKB using their upstream Customer FHIR API.

    • A Customer endpoint will only apply simple syntax validation to the FHIR resources provided. No other business rules or profile validation will be performed.

    • Not guaranteed to conform to any particular profile.

 

Resource Type

Non-FHIR Data

FHIR Data

Mapped to FHIR

Available in Aggregated API

PKB Profile (if one exists)

Visible in PKB UI

Available in Aggregated API

Visible in PKB UI

AllergyIntolerance

Aggregated AllergyIntolerance

Appointment

Aggregated Appointment

CodeSystem

N/A

Communication

 

Condition

Aggregated Condition

Consent

Aggregated Consent

Device

N/A

DeviceRequest

N/A

DeviceUseStatement

N/A

DiagnosticReport

N/A

DocumentReference

N/A

Encounter

 

EpisodeOfCare

N/A

Flag

N/A

Immunization

N/A

ImmunizationRecommendation

N/A

Location

N/A

*

Medication

N/A

*

MedicationDispense

N/A

MedicationRequest

non-FHIR medication data is migrated into a MedicationStatement

MedicationStatement

Aggregated MedicationStatement

NutritionOrder

N/A

Observation

 

Organization

N/A

*

Patient

Aggregated Patient

Person

N/A

Practitioner

N/A

PractitionerRole

N/A

**

Procedure

N/A

ProcedureRequest

N/A

Questionnaire

N/A

QuestionnaireResponse

N/A

RelatedPerson

N/A

ServiceRequest

N/A

Specimen

N/A

ValueSet

N/A

*

* - These particular resources are not directly visible within the user interface (UI). However, its data is utilised and referenced by other visible resources. Example: The “Location” resource, while not individually shown in the UI, contributes location information to other resources such as the "Appointment" resource. Therefore, location details are visible within the context of an appointment, even though the "Location" resource itself is not directly shown. Essentially, this resource functions as a data provider, supplying necessary information to enhance the display of other user-facing resources.

** - PractitionerRole is a representation of the team and organization associations of a professional user of PKB. Therefore it is visible in the UI through team management screens.

 

 

 

Related content