getODSfull: getODSfull

In PublicHealthEngland/odsR: Extract and manipulate ODS data from the NHS Digital ODS ORD API

Description

Extracts full ODS data for a single organisation from the NHS Digital ODS ORD API into a list of length 1.

Usage

getODSfull(ODSCode, UseProxy = FALSE)

Arguments

ODSCode

The organisation to return details for; quoted string; no default

UseProxy

Whether to use proxy settings to connect to the directory.spineservices.nhs.uk/ODSAPISuite API. If TRUE, the function will look for a UseProxy.csv file in the package library extdata directory. The file must contain a single row of comma separated headers (url, port, username, password, auth) and a second row specifying the values to be passed to each of these httr::use_proxy() function arguments. All Argument headers must be present, leave values blank if not required. Quoted string, default FALSE

Value

returns a list of length 1 containing the full details for the Organisation including: Name, Legal and Operational Start and End Dates, Status, Last Change Date, Organisation Record Class, Address, Postcode, Contact Information, Roles and Relationships to other Organisations

Notes

View the NHS Digital ODS API Implementation Guide at https://developer.nhs.uk/library/identifiers/ods-ord-api-implementation-guide/

View the NHS Digital ODS API Suite at https://directory.spineservices.nhs.uk/ODSAPISuite

See Also

Other odsR package functions: OrgRelLkpGP(), OrgRelLkpNHSTrust(), addorgname(), getODS()

Examples

# return full Organisation data for RRF12
getODSfull(ODSCode="RRF12")

PublicHealthEngland/odsR documentation built on March 4, 2021, 1:57 a.m.