API docs by Redocly

Interneuron.NHSDigitalIntegration (1.0)

Download OpenAPI specification:Download

ERS

/ERS/CreateProfessionalSession

Request Body schema:
string

Responses

Request samples

Content type
"string"

Response samples

Content type
No sample

/ERS/DeleteProfessionalSession

Request Body schema:
string

Responses

Request samples

Content type
"string"

/ERS/SelectProfessionalRole

Request Body schema:
accessToken
string or null
sessionKey
string or null

Responses

Request samples

Content type
{
  • "accessToken": "string",
  • "sessionKey": "string"
}

Response samples

Content type
No sample

/ERS/RetrieveWorklist

Request Body schema:
string

Responses

Request samples

Content type
"string"

Response samples

Content type
No sample

/ERS/RetrieveReferralRequest/{sessionKey}/{ubrn}

path Parameters
sessionKey
required
string
ubrn
required
string

Responses

Response samples

Content type
No sample

/ERS/RetrieveAttachment/{sessionKey}/{attachmentLogicalId}

path Parameters
sessionKey
required
string
attachmentLogicalId
required
string

Responses

Response samples

Content type
No sample

GPConnect

/GPConnect/HasRunningGPConnectSyncProcessForNHSNumber

Authorizations:
oauth2
query Parameters
nhsNumber
string
api-version
string
Default: "1.0"

The requested API version

Responses

Response samples

Content type
No sample

/GPConnect/SyncStructuredRecord

Authorizations:
oauth2
query Parameters
api-version
string
Default: "1.0"

The requested API version

Request Body schema:
nhsNumber
string or null
practitionerIdentifier
string or null

Responses

Request samples

Content type
{
  • "nhsNumber": "string",
  • "practitionerIdentifier": "string"
}

Response samples

Content type
No sample

/GPConnect/StructuredRecordByNHSNumber

Authorizations:
oauth2
query Parameters
nhsNumber
string
api-version
string
Default: "1.0"

The requested API version

Responses

Response samples

Content type
No sample

/GPConnect/GetStructuredRecordByAttributes

Authorizations:
oauth2
query Parameters
api-version
string
Default: "1.0"

The requested API version

Request Body schema:
nhsNumber
string or null
acuteMedicationsSinceInMonths
integer or null <int32>
repeatMedicationsSinceInMonths
integer or null <int32>

Responses

Request samples

Content type
{
  • "nhsNumber": "string",
  • "acuteMedicationsSinceInMonths": 0,
  • "repeatMedicationsSinceInMonths": 0
}

Response samples

Content type
No sample

PersonDemographicsService

/PersonDemographics/VerifyPatientNHSNumber/{nhsNumber}

Authorizations:
oauth2
path Parameters
nhsNumber
required
string
query Parameters
api-version
string
Default: "1.0"

The requested API version

Responses

Response samples

Content type
No sample

/PersonDemographics/VerifyPatientNHSNumberInSynapse/{nhsNumber}

Authorizations:
oauth2
path Parameters
nhsNumber
required
string
query Parameters
api-version
string
Default: "1.0"

The requested API version

Responses

Response samples

Content type
No sample

Utility

/Utility/SeedPDSTestDataToSynapse

Authorizations:
oauth2
query Parameters
nhsNumber
string
api-version
string
Default: "1.0"

The requested API version

Responses

Response samples

Content type
No sample

/Utility/SeedEncounterTestDataToSynapse

Authorizations:
oauth2
query Parameters
nhsNumber
string
patientClassCode
string
Default: "IP"
inactivateExisting
boolean
Default: true
isFutureEncounter
boolean
Default: false
api-version
string
Default: "1.0"

The requested API version

Responses

/Utility/DeleteExistingGPConnectData

Authorizations:
oauth2
query Parameters
nhsNumber
string
api-version
string
Default: "1.0"

The requested API version

Responses

/Utility/GetActiveEncounterByNHSNumber

Authorizations:
oauth2
query Parameters
nhsNumber
string
api-version
string
Default: "1.0"

The requested API version

Responses

/Utility/HasActiveEncounterByNHSNumber

Authorizations:
oauth2
query Parameters
nhsNumber
string
api-version
string
Default: "1.0"

The requested API version

Responses