Observation code ranges

Get observation code ranges

get
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters
observationCodeIdnumberRequired

ID of the observation code

Example: 1
observationCodeNamestring[]Required

Names of the observation codes

Default: []Example: ["code1","code2"]
Responses
200Success
application/json
get
/api/observation-code-ranges
200Success

Create observation code range

post
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Bodyobject[]
object[]Optional
Responses
200Success
application/json
post
/api/observation-code-ranges
200Success

Get observation code range by ID

get
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
get
/api/observation-code-ranges/{id}
200Success

Update observation code range by ID

put
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Body
idnumberOptional

ID of the observation code range

Example: 1
namestringOptional

Name of the observation code range

Example: Normal Range
minstringOptional

Minimum value of the observation code range

Example: 90
maxstringOptional

Maximum value of the observation code range

Example: 120
genderstring · enumOptional

Gender for which the observation code range is applicable

Example: MALEPossible values:
observationCodeIdnumberOptional

ID of the observation code

Example: 101
observationCodeNamestringOptional

Name of the observation code

Example: Blood Pressure
attributesobjectOptional

Additional attributes for the observation code range

Example: {"unit":"mmHg"}
observationPurposeRangeLabelIdnumberOptional
Responses
200Success
application/json
put
/api/observation-code-ranges/{id}
200Success

Delete observation code range by ID

delete
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
delete
/api/observation-code-ranges/{id}
200Success