| GET POST | /sherpaCodeInstruction | Get Instructions for a specific code | |
|---|---|---|---|
| GET POST | /sherpaCodeInstruction/{code} | Get Instructions for a specific code | Code can be directly within the URL as part of the path |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| code | path | string | No | The code to find instructions for (if any) |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/SherpaCodeInstruction HTTP/1.1
Host: api.vitalware.com
Content-Type: text/jsv
Content-Length: length
{
code: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
request:
{
code: String
},
result:
{
parameters:
{
param:
[
{
type: String,
value: String,
hasInfo: False,
isAlias: False,
isDIndex: False,
position: 0
}
]
},
messages:
[
{
message: String
}
],
results:
{
selectedDiagnosisTotal:
{
count: 0
},
selectedDiagnosisPageset:
{
diagnosis:
[
{
id: 0,
code: String,
codeAlt: String,
desc: String
}
]
},
selectedConcepts:
{
conceptType:
[
{
type: String,
typeID: 0,
count: 0,
concepts:
{
concept:
[
{
id: 0,
desc: String,
count: 0,
hasInfo: False
}
]
}
}
]
},
infoNodes:
{
info:
[
{
typeID: 0,
type: String,
label: String,
title: String,
description: String
}
]
},
instructions:
{
type: String,
instructionType:
[
{
type: String,
instruction:
[
{
instruction: String,
codeRanges: String
}
]
}
]
}
}
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String
}
]
}
}