PKB REST API evolution

In an effort to expedite the PKB transition to the next generation of REST APIs we have made the decision to deprecate a subset of our v0-v2 REST APIs.
The current list of active REST APIs are listed here: https://sandbox.patientsknowbest.com/api/index.html
According to our records and auditing, the following APIs are not being utilised or being developed against in any capacity. If this is not the case for your organisation please let us know as soon as possible.
The following APIs will be deprecated effective 16-05-2017
 
HTTP Operation Category Version URL
GET Allergies 1 /v1/allergies/apiRefs
GET Allergies 1 /v1/allergies/forPatient/{patientId}
GET Allergies 1 /v1/allergies
GET Allergies 2 /v2-beta/allergies
POST Allergies 2 /v2-beta/allergies/forPatient/{patientId}
POST Allergies 1 /v1/allergies
POST Allergies 1 /v1/allergies/forPatient/{patientId}
POST Allergies 2 /v2-beta/allergies
DELETE Allergies 1 /v1/allergies/forPatient/{patientId}
DELETE Allergies 2 /v2-beta/allergies/forPatient/{patientId}
DELETE Allergies 1 /v1/allergies
DELETE Allergies 2 /v2-beta/allergies
GET Appointments 1 /v1/appointments/self
POST Appointments 1 /v1/appointments/{patientId}
GET Careplans 2 /v2-beta/careplans
GET Careplans 2 /v2-beta/careplans/plan/{id}
POST Careplans 2 /v2-beta/careplans
POST Careplans 2 /v2-beta/careplans/{patientId}
DELETE Careplans 2 /v2-beta/careplans
DELETE Careplans 2 /v2-beta/careplans/{patientId}
GET Clinical Impression 2 /v2-beta/clinicalimpression/{patientId}
GET Clinical Impression 2 /v2-beta/clinicalimpression
POST Clinical Impression 2 /v2-beta/clinicalimpression/{patientId}
POST Clinical Impression 2 /v2-beta/clinicalimpression/{patientId}/{clinicalImpressionId}/investigations/{clinicalResourceType}
POST Clinical Impression 2 /v2-beta/clinicalimpression/{clinicalImpressionId}/investigations/{clinicalResourceType}
POST Clinical Impression 2 /v2-beta/clinicalimpression
PUT Clinical Impression 2 /v2-beta/clinicalimpression/{clinicalImpressionId}/investigations/{clinicalResourceType}
PUT Clinical Impression 2 /v2-beta/clinicalimpression
PUT Clinical Impression 2 /v2-beta/clinicalimpression/{patientId}
PUT Clinical Impression 2 /v2-beta/clinicalimpression/{patientId}/{clinicalImpressionId}/investigations/{clinicalResourceType
DELETE Clinical Impression 2 /v2-beta/clinicalimpression/{clinicalImpressionId}
DELETE Clinical Impression 2 /v2-beta/clinicalimpression/{patientId}/{clinicalImpressionId}
DELETE Clinical Impression 2 /v2-beta/clinicalimpression/{patientId}/{clinicalImpressionId}/investigations/{clinicalResourceType}
DELETE Clinical Impression 2 /v2-beta/clinicalimpression/{clinicalImpressionId}/investigations/{clinicalResourceType}
GET Data Upload 1 /v1/datauploads/config/all
GET Data Upload 1 /v1/datauploads/config/now
POST Data Upload 1 /v1/datauploads
POST Data Upload 1 /v1/datauploads/audit
POST Data Upload 1 /v1/datauploads/register
GET Diagnoses 2 /v2-beta/diagnoses
GET Diagnoses 0 /diagnoses/all
GET Diagnoses 1 /v1/diagnoses
GET Diagnoses 1 /v1/diagnoses/apiRefs
GET Diagnoses 1 /v1/diagnoses/forPatient/{patientId}
POST Diagnoses 1 /v1/diagnoses
POST Diagnoses 1 /v1/diagnoses/forPatient/{patientId}
POST Diagnoses 2 /v2-beta/diagnoses/forPatient/{patientId}/{diagnosisId}/referralRequests
POST Diagnoses 2 /v2-beta/diagnoses
POST Diagnoses 2 /v2-beta/diagnoses/forPatient/{patientId}
POST Diagnoses 2 /v2-beta/diagnoses/{diagnosisId}/referralRequests
DELETE Diagnoses 2 /v2-beta/diagnoses/forPatient/{patientId}
DELETE Diagnoses 2 /v2-beta/diagnoses
DELETE Diagnoses 1 /v1/diagnoses/forPatient/{patientId}
DELETE Diagnoses 2 /v2-beta/diagnoses/forPatient/{patientId}/{diagnosisId}/referralRequests
DELETE Diagnoses 1 /v1/diagnoses
DELETE Diagnoses 2 /v2-beta/diagnoses/{diagnosisId}/referralRequests
GET Disabilities 2 /v2-beta/disabilities
GET Disabilities 2 /v2-beta/disabilities/{patientId}
POST Disabilities 2 /v2-beta/disabilities
POST Disabilities 2 /v2-beta/disabilities/{patientId}
DELETE Disabilities 2 /v2-beta/disabilities
DELETE Disabilities 2 /v2-beta/disabilities/{patientId}
POST Discharge 2 /v2-beta/discharge/{patientId}
POST Discharge 2 /v2-beta/discharge/{patientId}/{teamCode}
GET Employment 2 /v2-beta/employment
GET Employment 2 /v2-beta/employment/{patientId}
POST Employment 2 /v2-beta/employment
POST Employment 2 /v2-beta/employment/{patientId}
DELETE Employment 2 /v2-beta/employment/{employmentId}
DELETE Employment 2 /v2-beta/employment/{patientId}/{employmentId}
GET Encounters 2 /v2-beta/encounters/forPatient/{patientId}
POST Encounters 2 /v2-beta/encounters
POST Encounters 2 /v2-beta/encounters/forPatient/{patientId}
POST Encounters 2 /v2-beta/encounters/forPatient/{patientId}/{encounterId}/messages
POST Encounters 2 /v2-beta/encounters/forPatient/{patientId}/{encounterId}/participants
POST Encounters 2 /v2-beta/encounters/{encounterId}/messages
POST Encounters 2 /v2-beta/encounters/{encounterId}/participants
DELETE Encounters 2 /v2-beta/encounters
DELETE Encounters 2 /v2-beta/encounters/forPatient/{patientId}
GET End Of Life 0 /eolPlans/forPatientByNationalId/{country}/{idNumber}
GET End Of Life 1 /v1/eolPlans/forPatientByNationalId/{country}/{idNumber}
GET Episode of Care 2 /v2-beta/episodeofcare
POST Episode of Care 2 /v2-beta/episodeofcare
PUT Episode of Care 2 /v2-beta/episodeofcare
DELETE Episode of Care 2 /v2-beta/episodeofcare/{episodeOfCareIdList}
GET Family Member History 2 /v2-beta/familymemberhistory/condition/apiRefs
GET Family Member History 2 /v2-beta/familymemberhistory
GET Family Member History 2 /v2-beta/familymemberhistory/{patientId}
POST Family Member History 2 /v2-beta/familymemberhistory/{familyMemberHistoryId}/condition
POST Family Member History 2 /v2-beta/familymemberhistory/{patientId}
POST Family Member History 2 /v2-beta/familymemberhistory
POST Family Member History 2 /v2-beta/familymemberhistory/{patientId}/{familyMemberHistoryId}/condition
DELETE Family Member History 2 /v2-beta/familymemberhistory/{patientId}
DELETE Family Member History 2 /v2-beta/familymemberhistory/{familyMemberHistoryId}/condition
DELETE Family Member History 2 /v2-beta/familymemberhistory/{patientId}/{familyMemberHistoryId}/condition
DELETE Family Member History 2 /v2-beta/familymemberhistory
GET Immunization 1 /v1/immunizations
GET Immunization 1 /v1/immunizations/forPatient/{patientId}
POST Immunization 1 /v1/immunizations
POST Immunization 1 /v1/immunizations/forPatient/{patientId}
DELETE Immunization 1 /v1/immunizations
DELETE Immunization 1 /v1/immunizations/forPatient/{patientId}
GET Journals 1 /v1/journal/forPatient/{patientId}
GET Library 1 /v1/library/forPatient/{patientId}
GET Library 1 /v1/library/forTeam/{teamCode}
POST Library 1 /v1/library/forPatient/{patientId}
POST Library 1 /v1/library/forTeam/{teamCode}
DELETE Library 1 /v1/library/forPatient/{patientId}
DELETE Library 1 /v1/library/forTeam/{teamCode}
GET Measurements 1 /v1/measurements/latestMeasurement/forPatient/byTypes
GET Measurements 1 /v1/measurements/byType/{type}
GET Measurements 1 /v1/measurements/historyByType/{type}
GET Measurements 1 /v1/measurements/latest/forPatient/byTypes
GET Measurements 1 /v1/measurements/all
GET Measurements 1 /v1/measurements/types/all
GET Measurements 0 /measurements/byType/{type}
GET Measurements 2 /v2-beta/measurements
POST Measurements 0 /measurements
POST Measurements 1 /v1/measurements/forPatient/{patientid}
POST Measurements 2 /v2-beta/measurements
POST Measurements 2 /v2-beta/measurements/forPatient/{patientId}/{measurementId}/referralRequests
POST Measurements 2 /v2-beta/measurements/{measurementId}/referralRequests
DELETE Measurements 2 /v2-beta/measurements/{measurementId}/referralRequests
DELETE Measurements 2 /v2-beta/measurements/{patientId}
DELETE Measurements 2 /v2-beta/measurements/forPatient/{patientId}/{measurementId}/referralRequests
DELETE Measurements 2 /v2-beta/measurements
GET Medications 1 /v1/medications
GET Medications 1 /v1/medications/forPatient/{patientId}/active
POST Medications 1 /v1/medications/forPatient/{patientid}
DELETE Medications 1 /v1/medications
DELETE Medications 1 /v1/medications/forPatient/{patientId}
GET Messages 1 /v1/messages/before/{timestamp}
GET Messages 1 /v1/messages/all
GET Messages 0 /messages/attachments/{id}
GET Messages 0 /messages/before/{timestamp}
GET Messages 0 /messages/all
GET Messages 1 /v1/messages/after/{timestamp}
POST Messages 0 /messages/attachments
PUT Messages 1 /v1/messages/attachments/{name}
GET Observations 1 /v1/observations/apiRefs
GET Observations 1 /v1/observations/forPatient/{patientId}
GET Observations 1 /v1/observations
GET Observations 2 /v2-beta/observations
GET Observations 2 /v2-beta/observations/apiRefs
GET Observations 2 /v2-beta/observations/{patientId}
POST Observations 2 /v2-beta/observations/{patientId}
POST Observations 1 /v1/observations
POST Observations 1 /v1/observations/forPatient/{patientId}
POST Observations 2 /v2-beta/observations
DELETE Observations 1 /v1/observations/forPatient/{patientId}
DELETE Observations 2 /v2-beta/observations/{patientId}
DELETE Observations 1 /v1/observations
DELETE Observations 2 /v2-beta/observations
GET Patient Education 2 /v2-beta/patienteducation/apiRefs
GET Patient Education 2 /v2-beta/patienteducation/clinicialResourceTypes
GET Patient Education 2 /v2-beta/patienteducation/{clinicalResourceType}
GET Patient Education 2 /v2-beta/patienteducation/{clinicalResourceType}/{patientId}
POST Patient Education 2 /v2-beta/patienteducation/{clinicalResourceType}
POST Patient Education 2 /v2-beta/patienteducation/{clinicalResourceType}/{patientId}
POST Patient Education 2 /v2-beta/patienteducation/{patientEducationId}/participants
DELETE Patient Education 2 /v2-beta/patienteducation/{clinicalResourceType}
DELETE Patient Education 2 /v2-beta/patienteducation/{clinicalResourceType}/{patientId}
GET Pregnancies 1 /v1/pregnancies/current
GET Pregnancies 1 /v1/pregnancies/forPatient/{patientId}
GET Pregnancies 1 /v1/pregnancies/forPatient/{patientId}/current
GET Pregnancies 1 /v1/pregnancies
GET Pregnancies 1 /v1/pregnancies/growthchart/{id}

Leave a Reply