Sample requests to introduce the Organisation Data Terminology FHIR R4 API
\nMore documentation can be found in our open API specification online at:
\nhttps://digital.nhs.uk/developer/api-catalogue/organisation-data-terminology#get-/Organization
\nWe have also published implementation guidance here:
\nhttps://simplifier.net/guide/organisation-data-services
\nIf you have any questions please contact us at exeter.helpdesk@nhs.net
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"26163840","collectionId":"7697b93e-0852-4259-ab69-72c07fd2e17f","publishedId":"2sA3dvmD94","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-02T10:56:20.000Z"},"item":[{"name":"retrieve an organisation record","item":[{"name":"Organisation exists","event":[{"listen":"test","script":{"id":"8a3b4013-0267-45bf-a4ff-cfba407d7c10","exec":["pm.test('Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","})\r","\r","pm.test(\"CHeck id matches parameter\", function () {\r"," pm.expect(pm.response.json().id).to.eql(\"G81086\");\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"19c10a29-4475-4a5a-ae8d-26a242a3309c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization/RR8","urlObject":{"path":["Organization","RR8"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"description":{"content":"our data can also be returned in XML
\n","type":"text/plain"},"key":"_format","value":"xml"}],"variable":[]}},"response":[],"_postman_id":"19c10a29-4475-4a5a-ae8d-26a242a3309c"},{"name":"Invalid organisation request","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 400\", function () {\r"," pm.response.to.have.status(400);\r","});\r",""],"type":"text/javascript","id":"f2f3f03a-9fb7-4166-91aa-8d653f57b28e"}}],"id":"36cede63-14b0-4cbf-b3b6-f24921ede567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?INVALID","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"INVALID","value":null}],"variable":[]}},"response":[],"_postman_id":"36cede63-14b0-4cbf-b3b6-f24921ede567"},{"name":"Organisation does not exist","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 404\", function () {\r"," pm.response.to.have.status(404);\r","});"],"type":"text/javascript","id":"bba82bfb-7970-4ff2-8f39-07f82757f645"}}],"id":"8d5f54b2-e162-47ef-aa78-7922ac120283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization/8J632648493","urlObject":{"path":["Organization","8J632648493"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"key":"_format","value":"xml"}],"variable":[]}},"response":[],"_postman_id":"8d5f54b2-e162-47ef-aa78-7922ac120283"},{"name":"Return additional properties from the CodeSystem","event":[{"listen":"test","script":{"id":"43674d3a-d751-4285-a80d-8e55bab5f85c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"dba03785-ba83-44fa-85d5-89472968a2c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=G81086&property=RE4&property=RE8&property=ICB&property=NHSER","description":"This Query requests the Commissioner (RE4) and Partner (RE8) Related Entities and the Geographic Integrated Care Board And NHS England Region. For other properties in this CodeSystem refer to the Codesystem Summary
\n","urlObject":{"path":["CodeSystem","$lookup"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"This CodeSystem contains additional properties not stored within the Organization Resource
\n","type":"text/plain"},"key":"system","value":"https://fhir.nhs.uk/Id/ods-organization-code"},{"key":"code","value":"G81086"},{"description":{"content":"Commissioner - includes the latest commissioning organisation
\n","type":"text/plain"},"key":"property","value":"RE4"},{"description":{"content":"Properties are only included when the relevant relationship is present
\n","type":"text/plain"},"key":"property","value":"RE8"},{"description":{"content":"Additional Geographic Identifiers are included
\n","type":"text/plain"},"key":"property","value":"ICB"},{"description":{"content":"NHS England Region
\n","type":"text/plain"},"key":"property","value":"NHSER"}],"variable":[]}},"response":[],"_postman_id":"dba03785-ba83-44fa-85d5-89472968a2c3"}],"id":"e5693467-6091-4829-b5af-e7999d069a1e","_postman_id":"e5693467-6091-4829-b5af-e7999d069a1e","description":""},{"name":"Search for organisations","item":[{"name":"Search using date range","event":[{"listen":"test","script":{"id":"8bbc9941-280a-43a1-94e3-31728990bd15","exec":[""],"type":"text/javascript","packages":{}}}],"id":"1f857f13-7bf5-426f-abaa-8c5af007bbd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?lastChangeDate=lt2023-05-04&lastChangeDate=gt2023-05-02&_count=2","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"less than
\n","type":"text/plain"},"key":"lastChangeDate","value":"lt2023-05-04"},{"description":{"content":"greater than
\n","type":"text/plain"},"key":"lastChangeDate","value":"gt2023-05-02"},{"description":{"content":"Limit the number of results
\n","type":"text/plain"},"key":"_count","value":"2"},{"disabled":true,"key":"_format","value":"xml"}],"variable":[]}},"response":[],"_postman_id":"1f857f13-7bf5-426f-abaa-8c5af007bbd3"},{"name":"Search with no results","event":[{"listen":"test","script":{"id":"69e6768b-e27c-4c37-9b4e-be18c53b29b1","exec":[""],"type":"text/javascript","packages":{}}}],"id":"bb4d675a-9d0b-49f8-8f6a-f01d1aef7835","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?lastChangeDate=lt1900-04-01","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"this generaes no results
\n","type":"text/plain"},"key":"lastChangeDate","value":"lt1900-04-01"}],"variable":[]}},"response":[],"_postman_id":"bb4d675a-9d0b-49f8-8f6a-f01d1aef7835"},{"name":"Search active and retired roles","id":"3a4ebe99-53cd-4625-87a5-4336ddd58c99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?roleCode=RO197","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"roleCode includes both active and inactive roles RO197 = NHS Trust
\n","type":"text/plain"},"key":"roleCode","value":"RO197"}],"variable":[]}},"response":[],"_postman_id":"3a4ebe99-53cd-4625-87a5-4336ddd58c99"},{"name":"Search active roles only","id":"fe85e79d-b53c-4a4f-8f6d-c18a31ebba6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?activeRoleCode=RO197","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"activeRoleCode only returns matching roles with no opEndDate present
\n","type":"text/plain"},"key":"activeRoleCode","value":"RO197"}],"variable":[]}},"response":[],"_postman_id":"fe85e79d-b53c-4a4f-8f6d-c18a31ebba6c"},{"name":"Search using _count and _offset","id":"f36dfb2c-8023-4d67-85db-0a9961a963f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?roleCode=RO76&_count=2000&_offset=4000","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"GP Practice
\n","type":"text/plain"},"key":"roleCode","value":"RO76"},{"description":{"content":"count can be used to specifc a subset for paginating, no longer limited to 1000 (default is 20)
\n","type":"text/plain"},"key":"_count","value":"2000"},{"description":{"content":"when used with count, allows to reqyest subseuqent 'pages'
\n","type":"text/plain"},"key":"_offset","value":"4000"}],"variable":[]}},"response":[],"_postman_id":"f36dfb2c-8023-4d67-85db-0a9961a963f9"},{"name":"Search multiple roles","id":"faa9ae05-3507-412f-bb36-a8dd8b526d49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?activeRoleCode=RO98&activeRoleCode=RO319","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"Former CCG / Sub ICB Location
\n","type":"text/plain"},"key":"activeRoleCode","value":"RO98"},{"description":{"content":"Sub ICB location
\n","type":"text/plain"},"key":"activeRoleCode","value":"RO319"}],"variable":[]}},"response":[],"_postman_id":"faa9ae05-3507-412f-bb36-a8dd8b526d49"},{"name":"Search this role or that role","id":"cb555801-bc46-4793-9c95-1ab3bdddecd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?activeRoleCode=RO318,RO319","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"role enables search on all roles, RO318 = Integrated Care Board
\n","type":"text/plain"},"key":"activeRoleCode","value":"RO318,RO319"},{"disabled":true,"key":"role","value":"https://ods-prototype/role|RO319"}],"variable":[]}},"response":[],"_postman_id":"cb555801-bc46-4793-9c95-1ab3bdddecd6"},{"name":"Return all Organisation Records with a Dormant Flag","event":[{"listen":"test","script":{"id":"49c9ec29-6839-4e30-b8ae-96425a52e8b7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"80a7766b-1009-4fa8-a234-65cdf17e0c3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n \"filter\": [\r\n {\r\n \"property\": \"AAID8\",\r\n \"op\": \"exists\",\r\n \"value\": true\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"AAID8\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"80a7766b-1009-4fa8-a234-65cdf17e0c3c"},{"name":"Return all Organisation Records with a Proposed Flag","event":[{"listen":"test","script":{"id":"49c9ec29-6839-4e30-b8ae-96425a52e8b7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"bdbab2e6-ea1c-45bc-adfa-8b6ef5f50d3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n \"filter\": [\r\n {\r\n \"property\": \"AAID9\",\r\n \"op\": \"exists\",\r\n \"value\": true\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"AAID8\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdbab2e6-ea1c-45bc-adfa-8b6ef5f50d3f"}],"id":"d58472ef-3774-4c22-9991-80bfae310ceb","_postman_id":"d58472ef-3774-4c22-9991-80bfae310ceb","description":""},{"name":"retrieve a relationship record","item":[{"name":"Relationship exists","event":[{"listen":"test","script":{"id":"73c4070d-0b2a-4918-a4b0-c5a7b31584f8","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","// assert that 1 record returned"],"type":"text/javascript","packages":{}}}],"id":"e53b8c56-c60d-480e-8699-c606aa4a4c5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation/617400","urlObject":{"path":["OrganizationAffiliation","617400"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"description":{"content":"data can also be returned in XML
\n","type":"text/plain"},"key":"_format","value":"xml"}],"variable":[]}},"response":[],"_postman_id":"e53b8c56-c60d-480e-8699-c606aa4a4c5e"},{"name":"Relationship does not exist","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","// assert that 1 record returned"],"type":"text/javascript","id":"a65a7dfe-bbf9-42f0-98cc-678aff430a97"}}],"id":"f2abb4b8-fa0c-40a4-aae6-6b6f97aff27d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation/61740000","urlObject":{"path":["OrganizationAffiliation","61740000"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"key":"_format","value":"xml"}],"variable":[]}},"response":[],"_postman_id":"f2abb4b8-fa0c-40a4-aae6-6b6f97aff27d"},{"name":"Invalid relationship request","id":"dfbe7bcd-112b-496e-b258-e3bef7419972","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation?INVALID=INVALID","urlObject":{"path":["OrganizationAffiliation"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"INVALID","value":"INVALID"}],"variable":[]}},"response":[],"_postman_id":"dfbe7bcd-112b-496e-b258-e3bef7419972"}],"id":"6b107bfa-cbe3-475e-ba72-580e6618c942","_postman_id":"6b107bfa-cbe3-475e-ba72-580e6618c942","description":""},{"name":"Search for relationships","item":[{"name":"Search with no results","id":"451b1cc5-6a66-4149-9657-bbebad6dc6e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation?participating-organization=Q7Q","urlObject":{"path":["OrganizationAffiliation"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"participating-organization","value":"Q7Q"},{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"451b1cc5-6a66-4149-9657-bbebad6dc6e8"},{"name":"Search by primary-organization","id":"d7d4da58-24c6-413e-adbb-de75a114ae4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation?primary-organization=RR8","urlObject":{"path":["OrganizationAffiliation"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"formerly refered to as the Source Organisation
\n","type":"text/plain"},"key":"primary-organization","value":"RR8"}],"variable":[]}},"response":[],"_postman_id":"d7d4da58-24c6-413e-adbb-de75a114ae4f"},{"name":"Search by participating-organization","id":"6557f7e4-33bd-4034-a02a-2d7bea452d62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation?participating-organization=Q72","urlObject":{"path":["OrganizationAffiliation"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"formerly refered to as the Target Organisation
\n","type":"text/plain"},"key":"participating-organization","value":"Q72"}],"variable":[]}},"response":[],"_postman_id":"6557f7e4-33bd-4034-a02a-2d7bea452d62"},{"name":"Search by primary-organization and return related Organization resources","id":"6e96a659-6f2e-4069-946b-3daecf7f3182","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation?primary-organization=5N4C2&_include=OrganizationAffiliation:primary-organization&_include=OrganizationAffiliation:participating-organization","urlObject":{"path":["OrganizationAffiliation"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"formerly refered to as the Source Organisation
\n","type":"text/plain"},"key":"primary-organization","value":"5N4C2"},{"description":{"content":"includes the organization resources for the 'Source' Organisation
\n","type":"text/plain"},"key":"_include","value":"OrganizationAffiliation:primary-organization"},{"description":{"content":"includes the organization resources for the 'Target' Organisations
\n","type":"text/plain"},"key":"_include","value":"OrganizationAffiliation:participating-organization"}],"variable":[]}},"response":[],"_postman_id":"6e96a659-6f2e-4069-946b-3daecf7f3182"},{"name":"Search Organization resource and retrieve all relationships ","id":"e01d45a3-3590-42d5-8953-236285eb1d96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/Organization?identifier=G81086&_revinclude=OrganizationAffiliation:primary-organization","urlObject":{"path":["Organization"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"identifier","value":"G81086"},{"key":"_revinclude","value":"OrganizationAffiliation:primary-organization"}],"variable":[]}},"response":[],"_postman_id":"e01d45a3-3590-42d5-8953-236285eb1d96"},{"name":"Search by both primary-organization and participating-organization","id":"9ca6d536-d445-44c8-92bb-38d9721172f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation?primary-organization=RR8&participating-organization=Q72","urlObject":{"path":["OrganizationAffiliation"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"formerly referred to as the Source Organisation
\n","type":"text/plain"},"key":"primary-organization","value":"RR8"},{"description":{"content":"formerly referred to as the Target Organisation
\n","type":"text/plain"},"key":"participating-organization","value":"Q72"}],"variable":[]}},"response":[],"_postman_id":"9ca6d536-d445-44c8-92bb-38d9721172f0"},{"name":"Return all inward and outward relationships for single org","id":"738ac0a5-b48a-4452-86c7-685407409669","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/OrganizationAffiliation?primary-organization=G81086&_include=OrganizationAffiliation:primary-organization&_include=OrganizationAffiliation:participating-organization","urlObject":{"path":["OrganizationAffiliation"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"primary-organization","value":"G81086"},{"key":"_include","value":"OrganizationAffiliation:primary-organization"},{"key":"_include","value":"OrganizationAffiliation:participating-organization"}],"variable":[]}},"response":[],"_postman_id":"738ac0a5-b48a-4452-86c7-685407409669"}],"id":"7306c254-c3b7-45bc-b025-536ec56b33b1","_postman_id":"7306c254-c3b7-45bc-b025-536ec56b33b1","description":""},{"name":"Retrieve a practitioner record","item":[{"name":"Retrieve a practitioner record ","event":[{"listen":"test","script":{"id":"2a5479c9-9b7c-4a23-91df-0f1f00c8c539","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript","packages":{}}}],"id":"b43f9514-76f8-415d-ae2a-2e2369afe6a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner&code=80Y0298E&property=*","urlObject":{"path":["CodeSystem","$lookup"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"ensure only one example code from the list below is selected
\n","type":"text/plain"},"key":"system","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner"},{"disabled":true,"description":{"content":"GP Identifier
\n","type":"text/plain"},"key":"code","value":"G8130686"},{"description":{"content":"nurse Identifier
\n","type":"text/plain"},"key":"code","value":"80Y0298E"},{"disabled":true,"description":{"content":"consultant Identifier
\n","type":"text/plain"},"key":"code","value":"C6143900"},{"disabled":true,"description":{"content":"dental consultant Identifier
\n","type":"text/plain"},"key":"code","value":"CD064871"},{"description":{"content":"return all properties to see any other codes a practitioner may have.
\n","type":"text/plain"},"key":"property","value":"*"}],"variable":[]}},"response":[{"id":"1a3bed8d-607c-4720-9c3b-7a431961ef52","name":"Read GP","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{fhir-authoring}}/CodeSystem/$lookup?system=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner&code=CD064871&property=*","host":["{{fhir-authoring}}"],"path":["CodeSystem","$lookup"],"query":[{"key":"system","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner","description":"ensure only one example code from the list below is selected"},{"key":"code","value":"G8130686","description":"GP Identifier","disabled":true},{"key":"code","value":"80Y0298E","description":"nurse Identifier","disabled":true},{"key":"code","value":"C6143900","description":"consultant Identifier","disabled":true},{"key":"code","value":"CD064871","description":"dental consultant Identifier"},{"key":"property","value":"*","description":"return all properties to see any other codes a practitioner may have. in addition to code they may have additional identifiers\n"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b43f9514-76f8-415d-ae2a-2e2369afe6a4"}],"id":"32526853-2320-4aeb-a77b-f860fcb44ef7","_postman_id":"32526853-2320-4aeb-a77b-f860fcb44ef7","description":""},{"name":"Search for practitioners","item":[{"name":"return all of one Type","event":[{"listen":"test","script":{"id":"9a9af4f0-b6ed-477c-8ef2-fcd7b5fc3b00","exec":[""],"type":"text/javascript","packages":{}}}],"id":"250285a7-0f50-41fb-8489-a76dd51f0e56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\",\r\n \"filter\": [\r\n {\r\n \"property\": \"type\", \r\n \"op\": \"=\",\r\n \"value\": \"PDENTCON\"\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"type\"\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"5\"\r\n },\r\n {\r\n \"name\": \"count\",\r\n \"valueInteger\": 10\r\n }\r\n \r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[{"id":"c0d4e518-11a1-4b92-9ef3-655339118a96","name":"practitioner filter by Type PNURSE","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\",\r\n \"filter\": [\r\n {\r\n \"property\": \"type\", \r\n \"op\": \"=\",\r\n \"value\": \"PDENTCON\"\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"type\"\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"5\"\r\n },\r\n {\r\n \"name\": \"count\",\r\n \"valueInteger\": 10\r\n }\r\n \r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{fhir-authoring}}/ValueSet/$expand"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"250285a7-0f50-41fb-8489-a76dd51f0e56"},{"name":"Return all of one role","event":[{"listen":"test","script":{"id":"38d8094a-eb7c-44b0-a0b0-3b6c2ebfd318","exec":[""],"type":"text/javascript","packages":{}}}],"id":"81867ae3-ba5d-4a7b-8f55-cf176b2c05a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\",\r\n \"filter\": [\r\n {\r\n \"property\": \"role\", \r\n \"op\": \"=\",\r\n \"value\": \"PHOSPCON311\"\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"type\"\r\n }\r\n \r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"81867ae3-ba5d-4a7b-8f55-cf176b2c05a7"},{"name":"return all with an Northern Ireland GP identifier","event":[{"listen":"test","script":{"id":"5905e3f6-7dd8-411f-8df0-95183bf08da6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6cbe671f-e015-4122-bfd9-55dc10b8df43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\",\r\n \"filter\": [\r\n {\r\n \"property\": \"8\", // NIGP identifier\r\n \"op\": \"exists\",\r\n \"value\": true\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"type\"\r\n },\r\n \r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"8\"\r\n }\r\n \r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cbe671f-e015-4122-bfd9-55dc10b8df43"},{"name":"Search by General Medical Council (GMC) code","event":[{"listen":"test","script":{"id":"4a63a367-d0ab-4b59-92f9-10681a593e7a","exec":["\r",""],"type":"text/javascript","packages":{}}}],"id":"8f4d0621-6527-48da-98f1-26b1c4f9ac5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\",\r\n \"filter\": [\r\n {\r\n \"property\": \"7\", // General Medical Council (GMC) identifier\r\n \"op\": \"exists\",\r\n \"value\": true\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"type\"\r\n },\r\n \r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"8\"\r\n }\r\n \r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f4d0621-6527-48da-98f1-26b1c4f9ac5b"},{"name":"return all Nurse records which have an related organisation","event":[{"listen":"test","script":{"id":"ac3b205b-7ef1-4288-be75-7561c7742fb4","exec":["\r",""],"type":"text/javascript","packages":{}}}],"id":"798f527b-a4ef-4c5f-8e9f-d7704d1510d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\",\r\n \"filter\": [\r\n {\r\n \"property\": \"ME5\", \r\n \"op\": \"exists\",\r\n \"value\": true\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"type\"\r\n },\r\n \r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"ME5\"\r\n },\r\n {\r\n \"name\":\"count\",\r\n \"valueInteger\": 100\r\n }\r\n \r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"798f527b-a4ef-4c5f-8e9f-d7704d1510d8"},{"name":"return all English GP records which have an related organisation (limited to 100 results)","event":[{"listen":"test","script":{"id":"7aac8766-068c-4c14-af5b-d6816a5b631f","exec":[""],"type":"text/javascript","packages":{}}}],"id":"40e798bd-629a-4482-bb3a-528491100215","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\",\r\n \"filter\": [\r\n {\r\n \"property\": \"ME1\", \r\n \"op\": \"exists\",\r\n \"value\": true\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"type\"\r\n },\r\n \r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"ME1\"\r\n },\r\n {\r\n \"name\":\"count\",\r\n \"valueInteger\": 100\r\n }\r\n \r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"40e798bd-629a-4482-bb3a-528491100215"}],"id":"1190c69f-e3f2-4147-abaf-b7a177206aab","_postman_id":"1190c69f-e3f2-4147-abaf-b7a177206aab","description":""},{"name":"Search for practitioner relationships","item":[{"name":"Search by organisation code","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"ba8a3f8d-84e1-4899-9860-eeb74fd9f6f5"}}],"id":"94592e50-18e9-4f8d-93dd-6f1b17685aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n \r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-relationship-instance\",\r\n \"filter\": [\r\n {\r\n \"property\": \"orgCode\",\r\n \"op\": \"=\",\r\n \"value\": \"G81086\"\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"AAID8\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{fhir-authoring}}/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["{{fhir-authoring}}"],"query":[],"variable":[]}},"response":[{"id":"a26201af-5b46-4144-8b66-bdf20f290843","name":"Search practitioner-relationship-instance filter by orgCode","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n \r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-relationship-instance\",\r\n \"filter\": [\r\n {\r\n \"property\": \"orgCode\",\r\n \"op\": \"=\",\r\n \"value\": \"G81086\"\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"AAID8\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{fhir-authoring}}/ValueSet/$expand"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"94592e50-18e9-4f8d-93dd-6f1b17685aa9"},{"name":"Search by practitioner code","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"d0ba971b-4c97-4ded-96d5-77514653d71a"}}],"id":"230ac89c-d16b-4f70-b279-5f324de071a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n \r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-relationship-instance\",\r\n \"filter\": [\r\n {\r\n \"property\": \"practitionerCode\",\r\n \"op\": \"=\",\r\n \"value\": \"G9212004\"\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"*\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{fhir-authoring}}/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["{{fhir-authoring}}"],"query":[],"variable":[]}},"response":[{"id":"9733e3dc-81ca-455e-b8f9-483d87345d86","name":"Search practitioner-relationship-instance filter by practitionerCode","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n \r\n {\r\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-relationship-instance\",\r\n \"filter\": [\r\n {\r\n \"property\": \"practitionerCode\",\r\n \"op\": \"=\",\r\n \"value\": \"G9212004\"\r\n }\r\n \r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"*\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{fhir-authoring}}/ValueSet/$expand"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"230ac89c-d16b-4f70-b279-5f324de071a8"}],"id":"1b69c33e-0fa5-4b3f-8bf1-62a7ec732c1d","_postman_id":"1b69c33e-0fa5-4b3f-8bf1-62a7ec732c1d","description":""},{"name":"Retrieve reference data","item":[{"name":"return all role codes","id":"38b3012b-cefe-423c-86ab-da5275c22c5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand?url=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole/vs&property=primaryRole","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"key":"property","value":"role"},{"key":"url","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole/vs"},{"key":"property","value":"primaryRole"},{"disabled":true,"key":"property","value":"*"},{"disabled":true,"key":"filter","value":"academ"}],"variable":[]}},"response":[],"_postman_id":"38b3012b-cefe-423c-86ab-da5275c22c5e"},{"name":"return a set of roles filtered on the name","id":"51d13341-a0a7-42b8-ac9a-ac43d7a8c861","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand?url=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole/vs&property=primaryRole&filter=academ","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"key":"property","value":"role"},{"key":"url","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole/vs"},{"key":"property","value":"primaryRole"},{"disabled":true,"key":"property","value":"*"},{"key":"filter","value":"academ"}],"variable":[]}},"response":[],"_postman_id":"51d13341-a0a7-42b8-ac9a-ac43d7a8c861"},{"name":"return all relationship type codes","id":"fc6de7d5-b8bb-44dd-9e68-e69db52c917e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand?url=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship/vs&property=*","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"key":"property","value":"role"},{"key":"url","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship/vs"},{"key":"property","value":"*"},{"disabled":true,"key":"filter","value":"academ"}],"variable":[]}},"response":[],"_postman_id":"fc6de7d5-b8bb-44dd-9e68-e69db52c917e"},{"name":"return all record classes","id":"11060457-286c-4200-a6a1-58a33f9831ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand?url=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass/vs&property=*","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"disabled":true,"key":"property","value":"role"},{"key":"url","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass/vs"},{"key":"property","value":"*"}],"variable":[]}},"response":[],"_postman_id":"11060457-286c-4200-a6a1-58a33f9831ce"},{"name":"return all practitioner roles","id":"8078599c-ab3b-4354-b531-fb73a40b1d40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{fhir-authoring}}/ValueSet/$expand?url=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-role/vs&property=*","urlObject":{"path":["ValueSet","$expand"],"host":["{{fhir-authoring}}"],"query":[{"disabled":true,"key":"property","value":"role"},{"key":"url","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-role/vs"},{"key":"property","value":"*"}],"variable":[]}},"response":[],"_postman_id":"8078599c-ab3b-4354-b531-fb73a40b1d40"},{"name":"Retrieve a single practitioner Role","event":[{"listen":"test","script":{"id":"da13b808-e977-4583-9905-148e84ecde58","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a0b2c292-c8b0-4829-ae6f-e3d51906cf2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-role&code=PGP1&property=*","urlObject":{"path":["CodeSystem","$lookup"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"system","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-role"},{"key":"code","value":"PGP1"},{"description":{"content":"all properties can be returned with asterisk or individually added
\n","type":"text/plain"},"key":"property","value":"*"}],"variable":[]}},"response":[],"_postman_id":"a0b2c292-c8b0-4829-ae6f-e3d51906cf2a"},{"name":"Retrieve an ONS geographical name","event":[{"listen":"test","script":{"id":"da13b808-e977-4583-9905-148e84ecde58","exec":[""],"type":"text/javascript","packages":{}}}],"id":"07a29e6d-0614-454c-aee9-fc5261e1376d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name&code=W05001558&property=*","urlObject":{"path":["CodeSystem","$lookup"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"system","value":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name"},{"key":"code","value":"W05001558"},{"description":{"content":"all properties can be returned with asterisk or individually added
\n","type":"text/plain"},"key":"property","value":"*"}],"variable":[]}},"response":[],"_postman_id":"07a29e6d-0614-454c-aee9-fc5261e1376d"}],"id":"dff229d4-c493-4656-a567-2ecea5638cd9","_postman_id":"dff229d4-c493-4656-a567-2ecea5638cd9","description":""},{"name":"validate data","item":[{"name":"Validate a code againast the Organisation CodeSystem","id":"e2d68411-f471-4c22-a152-bb8c75a1752a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{fhir-authoring}}/CodeSystem/$validate-code?url=https://fhir.nhs.uk/Id/ods-Organization-code&code=X24","urlObject":{"path":["CodeSystem","$validate-code"],"host":["{{fhir-authoring}}"],"query":[{"key":"url","value":"https://fhir.nhs.uk/Id/ods-Organization-code"},{"key":"code","value":"X24"},{"disabled":true,"key":"display","value":"BRANCH SURGERY"}],"variable":[]}},"response":[],"_postman_id":"e2d68411-f471-4c22-a152-bb8c75a1752a"},{"name":"Validate the status of an organisation","id":"f2775ab4-d1c6-4099-8e98-d914db981f81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{fhir-authoring}}/CodeSystem/$validate-code?url=https://fhir.nhs.uk/Id/ods-organization-code&code=RH8&status=active","urlObject":{"path":["CodeSystem","$validate-code"],"host":["{{fhir-authoring}}"],"query":[{"key":"url","value":"https://fhir.nhs.uk/Id/ods-organization-code"},{"key":"code","value":"RH8"},{"key":"status","value":"active"}],"variable":[]}},"response":[],"_postman_id":"f2775ab4-d1c6-4099-8e98-d914db981f81"},{"name":"validate the code and name of a given role","id":"de997cea-8364-41e9-b0bc-d76fc0eb7293","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{fhir-authoring}}/CodeSystem/$validate-code?url=https://fhir.nhs.uk/Id/ods-organization-code&code=RH8&display=Something Trust","urlObject":{"path":["CodeSystem","$validate-code"],"host":["{{fhir-authoring}}"],"query":[{"key":"url","value":"https://fhir.nhs.uk/Id/ods-organization-code"},{"key":"code","value":"RH8"},{"key":"display","value":"Something Trust"}],"variable":[]}},"response":[],"_postman_id":"de997cea-8364-41e9-b0bc-d76fc0eb7293"}],"id":"9d8e6a61-5381-426e-8ca7-92666f9d9d1f","_postman_id":"9d8e6a61-5381-426e-8ca7-92666f9d9d1f","description":""},{"name":"metadata","item":[{"name":"retrieve capability statement","id":"27989a3f-5264-4777-a3af-6715260d2cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/metadata","urlObject":{"path":["metadata"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"27989a3f-5264-4777-a3af-6715260d2cb0"}],"id":"cd97836a-8b78-49c1-bd0b-2bd21578868f","_postman_id":"cd97836a-8b78-49c1-bd0b-2bd21578868f","description":""},{"name":"Retrieve deleted records","item":[{"name":"deleted organisations","id":"f4a51537-86c3-4d0e-b02e-f3118a7de73c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/Organization-deletion?","urlObject":{"path":["List","Organization-deletion"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"key":"","value":null}],"variable":[]}},"response":[{"id":"86fb7fd7-b4fd-4ca3-81d9-e69f3b6a68b1","name":"200_Example_List_Organization - deletion","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/Organization-deletion"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 16:38:05 GMT"},{"key":"Content-Type","value":"application/fhir+json;charset=UTF-8"},{"key":"Content-Length","value":"393"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Location","value":"https://jenkins.ods.dc4h.link/fhir/List/Organization-deletion/_history/3"},{"key":"Etag","value":"W/\"3\""},{"key":"Last-Modified","value":"Wed, 06 Mar 2024 08:33:55 GMT"},{"key":"X-Krakend","value":"Version 2.4.1"},{"key":"X-Krakend-Completed","value":"false"},{"key":"X-Powered-By","value":"HAPI FHIR 6.8.3 REST Server (FHIR Server; FHIR 4.0.1/R4)"},{"key":"X-Request-Id","value":"c345d38f421a4b6f7ad262a713552f52"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization,AcceptX-FHIR-Starter,Origin,Accept,X-Requested-With,Content-Type,Access-Control-Request-Method,Access-Control-Request-Headers,Authorization,Prefer,Pragma,If-Match,If-None-Match"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"X-Cache-Status","value":"MISS"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"List\",\n \"id\": \"Organization-deletion\",\n \"meta\": {\n \"versionId\": \"3\",\n \"lastUpdated\": \"2024-03-06T08:33:55.775+00:00\",\n \"source\": \"#3c8d0fc7e6526ce0\"\n },\n \"status\": \"current\",\n \"mode\": \"working\",\n \"title\": \"List of Organization Resource Deletions\",\n \"date\": \"2024-01-25T00:00:00+00:00\",\n \"note\": [\n {\n \"text\": \"A list of complete Organisation records which have been deleted from the ODS Dataset\"\n }\n ],\n \"entry\": [\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FVG57\"\n }\n }\n },\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FJE57\"\n }\n }\n }\n ]\n}"}],"_postman_id":"f4a51537-86c3-4d0e-b02e-f3118a7de73c"},{"name":"deleted relationships","id":"9d4015f6-90d6-4525-9e0f-089d6a807c61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/OrganizationAffiliation-deletion","urlObject":{"path":["List","OrganizationAffiliation-deletion"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[{"id":"c770f9d2-dafa-4f81-94bf-e1ea0190facc","name":"200_Example_List_Organization - deletion","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/Organization-deletion"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 16:38:05 GMT"},{"key":"Content-Type","value":"application/fhir+json;charset=UTF-8"},{"key":"Content-Length","value":"393"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Location","value":"https://jenkins.ods.dc4h.link/fhir/List/Organization-deletion/_history/3"},{"key":"Etag","value":"W/\"3\""},{"key":"Last-Modified","value":"Wed, 06 Mar 2024 08:33:55 GMT"},{"key":"X-Krakend","value":"Version 2.4.1"},{"key":"X-Krakend-Completed","value":"false"},{"key":"X-Powered-By","value":"HAPI FHIR 6.8.3 REST Server (FHIR Server; FHIR 4.0.1/R4)"},{"key":"X-Request-Id","value":"c345d38f421a4b6f7ad262a713552f52"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization,AcceptX-FHIR-Starter,Origin,Accept,X-Requested-With,Content-Type,Access-Control-Request-Method,Access-Control-Request-Headers,Authorization,Prefer,Pragma,If-Match,If-None-Match"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"X-Cache-Status","value":"MISS"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"List\",\n \"id\": \"Organization-deletion\",\n \"meta\": {\n \"versionId\": \"3\",\n \"lastUpdated\": \"2024-03-06T08:33:55.775+00:00\",\n \"source\": \"#3c8d0fc7e6526ce0\"\n },\n \"status\": \"current\",\n \"mode\": \"working\",\n \"title\": \"List of Organization Resource Deletions\",\n \"date\": \"2024-01-25T00:00:00+00:00\",\n \"note\": [\n {\n \"text\": \"A list of complete Organisation records which have been deleted from the ODS Dataset\"\n }\n ],\n \"entry\": [\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FVG57\"\n }\n }\n },\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FJE57\"\n }\n }\n }\n ]\n}"}],"_postman_id":"9d4015f6-90d6-4525-9e0f-089d6a807c61"},{"name":"deleted succession","id":"00bc4020-ec18-4147-8fd5-0b9a868b0f87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/Organization-succession-deletion","urlObject":{"path":["List","Organization-succession-deletion"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[{"id":"7fd81fa8-c08c-4b45-83bf-74b16d112f2e","name":"200_Example_List_Organization - deletion","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/Organization-deletion"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 16:38:05 GMT"},{"key":"Content-Type","value":"application/fhir+json;charset=UTF-8"},{"key":"Content-Length","value":"393"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Location","value":"https://jenkins.ods.dc4h.link/fhir/List/Organization-deletion/_history/3"},{"key":"Etag","value":"W/\"3\""},{"key":"Last-Modified","value":"Wed, 06 Mar 2024 08:33:55 GMT"},{"key":"X-Krakend","value":"Version 2.4.1"},{"key":"X-Krakend-Completed","value":"false"},{"key":"X-Powered-By","value":"HAPI FHIR 6.8.3 REST Server (FHIR Server; FHIR 4.0.1/R4)"},{"key":"X-Request-Id","value":"c345d38f421a4b6f7ad262a713552f52"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization,AcceptX-FHIR-Starter,Origin,Accept,X-Requested-With,Content-Type,Access-Control-Request-Method,Access-Control-Request-Headers,Authorization,Prefer,Pragma,If-Match,If-None-Match"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"X-Cache-Status","value":"MISS"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"List\",\n \"id\": \"Organization-deletion\",\n \"meta\": {\n \"versionId\": \"3\",\n \"lastUpdated\": \"2024-03-06T08:33:55.775+00:00\",\n \"source\": \"#3c8d0fc7e6526ce0\"\n },\n \"status\": \"current\",\n \"mode\": \"working\",\n \"title\": \"List of Organization Resource Deletions\",\n \"date\": \"2024-01-25T00:00:00+00:00\",\n \"note\": [\n {\n \"text\": \"A list of complete Organisation records which have been deleted from the ODS Dataset\"\n }\n ],\n \"entry\": [\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FVG57\"\n }\n }\n },\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FJE57\"\n }\n }\n }\n ]\n}"}],"_postman_id":"00bc4020-ec18-4147-8fd5-0b9a868b0f87"},{"name":"deleted roles","id":"8329de47-fed4-422f-9738-42c4ddc906b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/Organization-succession-deletion","urlObject":{"path":["List","Organization-succession-deletion"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[{"id":"a398989d-205b-41f3-a848-408df4ff0df4","name":"200_Example_List_Organization - deletion","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/List/Organization-deletion"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Mar 2024 16:38:05 GMT"},{"key":"Content-Type","value":"application/fhir+json;charset=UTF-8"},{"key":"Content-Length","value":"393"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Location","value":"https://jenkins.ods.dc4h.link/fhir/List/Organization-deletion/_history/3"},{"key":"Etag","value":"W/\"3\""},{"key":"Last-Modified","value":"Wed, 06 Mar 2024 08:33:55 GMT"},{"key":"X-Krakend","value":"Version 2.4.1"},{"key":"X-Krakend-Completed","value":"false"},{"key":"X-Powered-By","value":"HAPI FHIR 6.8.3 REST Server (FHIR Server; FHIR 4.0.1/R4)"},{"key":"X-Request-Id","value":"c345d38f421a4b6f7ad262a713552f52"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization,AcceptX-FHIR-Starter,Origin,Accept,X-Requested-With,Content-Type,Access-Control-Request-Method,Access-Control-Request-Headers,Authorization,Prefer,Pragma,If-Match,If-None-Match"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"X-Cache-Status","value":"MISS"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"List\",\n \"id\": \"Organization-deletion\",\n \"meta\": {\n \"versionId\": \"3\",\n \"lastUpdated\": \"2024-03-06T08:33:55.775+00:00\",\n \"source\": \"#3c8d0fc7e6526ce0\"\n },\n \"status\": \"current\",\n \"mode\": \"working\",\n \"title\": \"List of Organization Resource Deletions\",\n \"date\": \"2024-01-25T00:00:00+00:00\",\n \"note\": [\n {\n \"text\": \"A list of complete Organisation records which have been deleted from the ODS Dataset\"\n }\n ],\n \"entry\": [\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FVG57\"\n }\n }\n },\n {\n \"date\": \"2024-01-17T00:00:00+00:00\",\n \"item\": {\n \"type\": \"Organization\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"FJE57\"\n }\n }\n }\n ]\n}"}],"_postman_id":"8329de47-fed4-422f-9738-42c4ddc906b4"}],"id":"ff4ca9e9-da22-4c4c-bd27-f03f4cc99ca8","_postman_id":"ff4ca9e9-da22-4c4c-bd27-f03f4cc99ca8","description":""},{"name":"Succession","item":[{"name":"return all the predecessors for an organisation","event":[{"listen":"test","script":{"id":"43674d3a-d751-4285-a80d-8e55bab5f85c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"024724be-e5fa-48df-a43b-c8696ca4eaea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=RRE&property=predecessor","urlObject":{"path":["CodeSystem","$lookup"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"","type":"text/plain"},"key":"system","value":"https://fhir.nhs.uk/Id/ods-organization-code"},{"description":{"content":"Codes are case sensitive
\n","type":"text/plain"},"key":"code","value":"RRE"},{"key":"property","value":"predecessor"}],"variable":[]}},"response":[],"_postman_id":"024724be-e5fa-48df-a43b-c8696ca4eaea"},{"name":"return all the successors for an organisation","event":[{"listen":"test","script":{"id":"43674d3a-d751-4285-a80d-8e55bab5f85c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"19c2429c-6a24-4125-a1bb-624ca1fd0b44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=801&property=successor&property=forwardSuccession&_format=xml","urlObject":{"path":["CodeSystem","$lookup"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[{"description":{"content":"","type":"text/plain"},"key":"system","value":"https://fhir.nhs.uk/Id/ods-organization-code"},{"key":"code","value":"801"},{"description":{"content":"returns an array of successors
\n","type":"text/plain"},"key":"property","value":"successor"},{"description":{"content":"returns an array of flags to indicate the succesors have been succeded themselves
\n","type":"text/plain"},"key":"property","value":"forwardSuccession"},{"key":"_format","value":"xml"}],"variable":[]}},"response":[],"_postman_id":"19c2429c-6a24-4125-a1bb-624ca1fd0b44"},{"name":"Search Organisations for a given successor","event":[{"listen":"test","script":{"id":"49c9ec29-6839-4e30-b8ae-96425a52e8b7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"10b3088c-b180-4c2f-a514-761772c81635","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resourceType\": \"Parameters\",\r\n \"parameter\": [\r\n {\r\n \"name\": \"valueSet\",\r\n \"resource\": {\r\n \"resourceType\": \"ValueSet\",\r\n \"compose\": {\r\n \"inactive\": true,\r\n \"include\": [\r\n {\r\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n \"filter\": [\r\n {\r\n \"property\": \"successor\", // change to predecessor if you want to look backwards\r\n \"op\": \"=\",\r\n \"value\": \"RRE\" // \r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"activeOnly\",\r\n \"valueBoolean\": false\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"successor\"\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"address1\"\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"address2\"\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"postcode\"\r\n },\r\n {\r\n \"name\": \"property\",\r\n \"valueString\": \"forwardSuccession\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/ValueSet/$expand","urlObject":{"path":["ValueSet","$expand"],"host":["https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir"],"query":[],"variable":[]}},"response":[],"_postman_id":"10b3088c-b180-4c2f-a514-761772c81635"}],"id":"33fe3017-ed05-45bb-8903-2b7236e8896c","_postman_id":"33fe3017-ed05-45bb-8903-2b7236e8896c","description":""},{"name":"authorisation","item":[{"name":"Organisation request with apikeyauthorisation","event":[{"listen":"test","script":{"id":"8a3b4013-0267-45bf-a4ff-cfba407d7c10","exec":["pm.test('Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","})\r","\r","pm.test(\"CHeck id matches parameter\", function () {\r"," pm.expect(pm.response.json().id).to.eql(\"G81086\");\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"8969f146-5fd6-4074-acbe-e4e0a9fa541d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"Update with your apikey and change the environment to prod by removing the 'sandbox' section from the url
\nyou can also generate keys for the int environment using the Digital Onboarding Service.
\nRefer to the OAS spec for more information.
\n","urlObject":{"protocol":"https","path":["organisation-data-terminology-api","fhir","Organization","RR8"],"host":["api","service","nhs","uk"],"query":[{"disabled":true,"description":{"content":"our data can also be returned in XML
\n","type":"text/plain"},"key":"_format","value":"xml"}],"variable":[]}},"response":[],"_postman_id":"8969f146-5fd6-4074-acbe-e4e0a9fa541d"}],"id":"1a35eec4-f894-4789-bac3-c37fe5e0884b","description":"This folder contains an example request including the apikey authorisation method described in our guidance:
\nOrganisation Data Terminology - FHIR API - NHS England Digital
\n","_postman_id":"1a35eec4-f894-4789-bac3-c37fe5e0884b"}],"event":[{"listen":"prerequest","script":{"id":"2281f427-bc0b-468f-a971-fd8c72acb061","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b1c63fa3-d03b-487b-b717-5883049cf508","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"fhir-server","value":"https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir","type":"string"}]}