Developer documentation‎ > ‎FHIR API‎ > ‎Roadmap‎ > ‎

Organization

This is a draft document. Please be aware that the contents are subject to change.

FHIR Organization Resource

https://www.hl7.org/fhir/organization.html

Overview

PKB supports 2 types of organisation:
  • [[Organisation]]
  • [[Team]]
Both of these are considered to be Organizations in FHIR.

There will be no attribute explicitly indicating whether an Organization resource is an [[Organisation]] or a [[Team]], but a [[Team]] will have a partOf attribute pointing to the [[Organisation]] it belongs to.

Relevant Entities

Endpoints

Protection CategoryInteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
Non ClinicalreadGET/Organization/<id>None
  • Patient
  • Professional
Retrieve a specific Organization./Organization/32272c1d-4545-4083-a86e-1b3b8315f374

Mappings

FHIRPKBNotes
Resource id<conditional>
If this FHIR Organization represents a PKB [[Organisation]]: [[Organisation.Public ID]]
Else if this FHIR Organization represents a PKB [[Team]]: [[Team.Public ID]] 
 
Organization.name<conditional>
If this FHIR Organization represents a PKB [[Organisation]]: [[Organisation.Name]]
Else if this FHIR Organization represents a PKB [[Team]]: [[Team.Name]]

Organization.partOf<conditional>
If this FHIR Organization represents a PKB [[Team]]: return a reference to the owning PKB [[Organisation]]
  • partOf: Reference
    • reference = the relative URL of the Organization resource.
Else: omit the partOf attribute 
 

Comments