Why

You must send in an Organization. The organization resource will be referenced as the Patient.managingOrganization and will be the data source for all data sent in for that patient in the upstream data store.

The organisation created will be linked to the organisation in PKB’s downstream data store by way of the identifiers used (see below), this is essential to enable the successful and accurate aggregation of data.

Note - this process only needs to be done once, with the logical id supplied stored on the client side for future reference and use in API calls.

How

When you send the organisation resource, you will need to send in two identifiers:
1. the logical id that you assign
2. the org code PKB has created in the downstream data store OR your organisation’s ODS code.
Assign the organisation a logical id so that it can be referenced in other resources.
PKB uses the org code or the ODS code to link up the organisation resource in the upstream store with the actual PKB organisation in PKB’s downstream data store.
This means, when you send in the organisation resource, you’ll need to add the org identifier and system into your Customer upstream store. I’ve added example elements below that will go into your Organisation resource.
Using a valid token for the Customer FHIR data store, POST https://<client>.fhir-api.sandbox.patientsknowbest.com/fhir/Organization
1. For instructions on how to obtain a valid token see: https://wiki.patientsknowbest.com/space/api/4644012033/Obtain+Upstream+"Customer"+Endpoint+Token

Coding Systems

PKB org code system: http://fhir.patientsknowbest.com/id/org-code

ODS code system: https://fhir.nhs.uk/Id/ods-organization-code

Very basic example Organization resource:

{
  "resourceType": "Organization",
  "id": "<Client assigned organization logical id>",
  "extension": [
    {
      "valueString": "Europe/London",
      "url": "http://fhir.patientsknowbest.com/structuredefinition/time-zone-id"
    }
  ],
"identifier": [
   {
     "value": "<PKB org code>",
     "system": "http://fhir.patientsknowbest.com/id/org-code"
   }
 ],
 "name": "<PKB org name>"
}

Creating FHIR Organization

Why

How

Coding Systems