Aggregated Endpoint Capabilities

Aggregated Endpoint Capabilities

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

AdverseEvent

N/A

AllergyIntolerance

Aggregated AllergyIntolerance

Appointment

AuditEvent

N/A

BiologicallyDerivedProduct

N/A

CarePlan

 

CareTeam

N/A

ChargeItem

N/A

3

ChargeItemDefinition

N/A

3

Claim

N/A

ClinicalImpression

N/A

CodeSystem

N/A

 

Communication

 

Composition

N/A

Condition

Consent

4

4

DetectedIssue

N/A

Device

N/A

DeviceRequest

N/A

DeviceUseStatement

N/A

DiagnosticReport

N/A

DocumentReference

N/A

Encounter

 

EpisodeOfCare

N/A

Flag

N/A

Goal

N/A

HealthcareService

N/A

4

Immunization

N/A

ImmunizationRecommendation

N/A

Invoice

N/A

3

Location

N/A

4

1

Medication

N/A

1

MedicationAdministration

N/A

MedicationDispense

N/A

MedicationKnowledge

N/A

MedicationRequest

Non-FHIR medication data is migrated into a MedicationStatement

MedicationStatement

NutritionOrder

N/A

Observation

 

Organization

4

 

1

4

1

Patient

Aggregated Patient

PaymentNotice

N/A

PaymentReconciliation

N/A

Person

N/A

Practitioner

N/A

PractitionerRole

N/A

2

Procedure

N/A

ProcedureRequest

N/A

Provenance

N/A

Questionnaire

N/A

QuestionnaireResponse

N/A

RelatedPerson

N/A

ServiceRequest

N/A

Specimen

N/A