Record classes endpoint
This page includes the record classes endpoint description, parameters and examples.
https://directory.spineservices.nhs.uk/ORD/2-0-0/recordclasses/<RecordClassId>?{parameters}
https://directory.spineservices.nhs.uk/ORD/2-0-0/recordclasses?{parameters}
Description
Retrieve CodeSystems information for Record Classes meta data.
Parameters
| Parameter | Description |
| _format | String - case sensitive Can take xml, json, text/json, text/xml, application/json and application/xml as arguments. If this parameter is not supplied, the format will default to JSON. Note that _format specifies the format in which descriptive content is displayed. |
Example
To retrieve details about a specific recordClassId use the following query:
https://directory.spineservices.nhs.uk/ORD/2-0-0/recordclasses/RC1
{"RecordClasses": [{"id": "RC1", "code": "1", "displayName": "HSCOrg"}]}
To return an XML representation:
https://directory.spineservices.nhs.uk/ORD/2-0-0/recordclasses/RC1?_format=xml
<?xml version="1.0"?>
<CodeSystem oid="2.16.840.1.113883.2.1.3.2.4.23" name="OrganisationRecordClass">
<RecordClasses>
<RecordClass>
<id>RC1</id>
<code>1</code>
<displayName>HSCOrg</displayName>
</RecordClass>
</RecordClasses>
</CodeSystem>
Use the following query retrieve information relating to all Record Classes.
https://directory.spineservices.nhs.uk/ORD/2-0-0/recordclasses
{"RecordClasses": [{"id": "RC1", "code": "1", "displayName": "HSCOrg"}, {"id": "RC2", "code": "2", "displayName": "HSCSite"}]}
To return an XML representation:
<?xml version="1.0"?>
<CodeSystem oid="2.16.840.1.113883.2.1.3.2.4.23" name=" OrganisationRecordClass ">
<RecordClasses>
<RecordClass>
<id>RC1</id>
<code>1</code>
<displayName>HSCOrg</displayName>
</RecordClass>
<RecordClass>
<id>RC2</id>
<code>2</code>
<displayName>HSCSite</displayName>
</RecordClass>
</RecordClasses>
</CodeSystem>
Last edited: 23 August 2019 2:48 pm