Validate Code
Page index
Introduction
Examples of extended operation $validate-code. For more information, see ValueSetValidateCode.
Request
GET [base]/ValueSet/nll-snomed-behandlingsorsak/
Request Headers
See HTTP Header and Authorization for generic information about all HTTP headers used by the National Medication List including information about authorization, purpose and access type. The authorization token is translated to an authority role. The authority role together with the purpose and type of access is used by the National Medication List to determine what actions a user may perform and what information the user may access.
| Header | Comment |
|---|---|
| authorization | The users's security token |
| prefer | Type of returned content |
| x-access | The cause for the call |
| x-context-id | An ID to group a sequence of requests |
| x-org-info | Information about the users's organisation |
| x-patientref | The logical ID of the patient |
| x-provenance | A provenance resource with information about the user interacting with NLL |
| x-purpose | The purpose of the call |
| x-request-id | A random and unique ID |
| x-user-agent | Information about the calling system |
Examples
Example 1 - Validate code using date
Example of how to use $validate-code with date-parameter.
Request
GET [base]/ValueSet/nll-snomed-behandlingsorsak/$validate-code?code=14175009&date=le2022-06-01
Request Headers
| Header | Value | Comment |
|---|---|---|
| x-request-id | 50e6f6c4-b10f-45d8-8a25-2d1d687cd797 |
|
| x-user-agent | {"name":"Test system testaren","version":"0.01010101010.1 beta"} |
Decoded value |
Response Body
The response shows that the code existed in the value set before 2022-06-01 with the display text "reumatisk ledsjukdom". See Example of validate a code in a ValueSet.
Example 2 - Validate that a code exists in current version of ValueSet
Example of how to use $validate-code to check if a code exists in the current version of the ValueSet.
Request
GET [base]/ValueSet/nll-snomed-behandlingsorsak/$validate-code?code=14175009
Request Parameters
| Header | Value | Comment |
|---|---|---|
| x-request-id | 50e6f6c4-b10f-45d8-8a25-2d1d687cd797 |
|
| x-user-agent | {"name":"Test system testaren","version":"0.01010101010.1 beta"} |
Decoded value |
Response Body
The response shows that the code doesn't exists in the current version of the value set. See Example of validate a code in a ValueSet.