Search this site
Embedded Files
Skip to main content
Skip to navigation
PKB APIs
Developer documentation
Coded data support
Connectivity
Network connectivity guidance
Custom REST API
Break The Glass
Scopes
Data Model
Developer tutorial
Appointment URL links
Join PKB URLs
Mail management
Custom REST APIs
FHIR APIs
Mass registration
Custom REST APIs
FHIR APIs
Quick Guide to PKB APIs that enable data extraction
Frequently requested APIs
High level overview of available APIs
Supported operations
Single sign-on (SSO)
Throughput and Threads
Email addresses
FHIR APIs
Aggregated
Roadmap
Customer
Roadmap
Facade
Operation Examples
REST Examples
Roadmap
Appointment
Appointment Discussion
Deactivate Team Member
Invite Team Member
MedicationStatement
Observation
Organization
Person
Send Questionnaire
Messaging
Roadmap
Roadmap
FHIR® Conformance
Capabilities
Aggregator
Facade
Messaging
Code Systems
DiagnosticReport Category
Document Status
Document Type
Observation Category
Privacy Label
Response Code
Structure Definitions
Communication Title
Conversation ID
Document Status
Sharing Disabled
Source Organisation
Source Person
Source Team
Source Text
Specialty
Specialty History
Team Alias
Aggregator Appointment
Facade Appointment
Facade Communication
Facade Consent
Facade DiagnosticReport
Facade DocumentReference
Facade Encounter
Facade NamingSystem
Facade Observation
Facade Organization
Facade Patient
Facade Practitioner
Facade Provenance
Facade Questionnaire
Facade QuestionnaireResponse
Facade RelatedPerson
Facade ProcedureRequest
Identifier Systems
Operations
Date of last data point
Generate invitation tokens
Group
Process message
Purview
Read receipt query
Status query
Send questionnaire request
Search Parameters
Document Status
Source Organisation
HL7 API
Code sets
Connecting to PKB
Partner connections
Encounters
Identifiers & matching
Integration engine configurations
Messages
ACK
ADT A01
ADT A02
ADT A03
ADT A05
ADT A08
ADT A11
ADT A12
ADT A13
ADT A14
ADT A27
ADT A28
ADT A31
ADT A38
MDM T02
Care Plan
Document
MDM T11
ORU R01
Laboratory
Radiology
QRY A19
SIU S12
SIU S13
SIU S14
SIU S15
SIU S26
Roadmap
ADT A08 - Event Type Matching
Appointment Partners
Next of Kin (NK1)
Primary Care Provider (GP Details)
Remove from teams
Segments
MSH
PID
Setting up an HL7 API configuration
Team membership
Time stamp values
National ID generator
OAuth 2.0
Client credentials
Client ID
Code grant
Tethered-token system client
Privacy labels
Test code mapping
Test scripts
Demographics
Laboratory results
Roadmap
Roadmap 2021
Roadmap 2020
Roadmap 2019/11
Roadmap 2019/03
Roadmap 2018/11
Roadmap 2018/06
Roadmap 2017/09
Roadmap 2017/03
Roadmap 2016/09
Roadmap 2016/01
PKB APIs
Segments
Please see the subpages for details of standard segments.
Report abuse
Page details
Page updated
Report abuse