A CodeSystem defines a set of codes with meanings.
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® Reasonable Adjustments API. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
Warning: This site is provided for information only and is intended for those engaged with NHS Digital. It is advised not to develop against these specifications until a formal announcement has been made.
0. References
User Stories: - |
1. Read
GET [baseUrl]/CodeSystem/[id]
Return a single CodeSystem for the specified id.
By default the response will be returned in JSON, however XML is also supported.
1.1. Response
A full set of response codes can be found here API Response Codes. FHIR Servers SHALL support the following response codes:
| 200 | OK |
| 404 | Not Found |
| 500 | Internal Server Error |
2. Example
2.1 Request Query
Return the CodeSystem ODS lookup API ‘ODS API Organization Role’. Replace ‘baseUrl’ with the actual base Url of the FHIR Server.
2.1.1. cURL
curl -H 'Accept: application/fhir+xml' -X GET 'https://fhir.nhs.uk/STU3/CodeSystem/ODSAPI-OrganizationRecordClass-1'