Retrieve Procedure for a Procedure Identifier
get
/ohfapi/cg/v3.3/patientapi/procedures/{id}
This endpoint supports the retrieval of Procedures for a single Procedure Identifier. It returns the procedure information linked to the identifier.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
Procedure Row ID
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : Procedure
Type:
object
Model for a Patient procedure object in CDM.
Show Source
-
bodySite(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
-
category(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
-
code(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
-
encounter(optional):
object Encounter
-
identifier(optional):
object Identifier
Identifier assigned by a given system
-
outcome(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
-
patient(optional):
object LinkedReference
-
patientcondition(optional):
object LinkedReference
-
performedPeriod(optional):
object DateRange
-
performer(optional):
object Practitioner
Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.
-
subject(optional):
object LinkedReference
Nested Schema : CodeableConcept
Type:
object
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
Show Source
-
coding(optional):
array coding
Read Only:
true
Code(s) defined by a terminology system. -
text(optional):
string
Plain text representation of the concept.
Nested Schema : Encounter
Type:
Show Source
object
-
identifier(optional):
object CdmIdentifier
Identifier assigned by a given system
-
location(optional):
object Location
-
sequence(optional):
object Number
-
type(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
Nested Schema : Identifier
Type:
object
Identifier assigned by a given system
Show Source
-
system(optional):
string
System which assigned this identifier
-
value(optional):
string
Identifier value
Nested Schema : Practitioner
Type:
object
Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.
Show Source
-
address(optional):
object Address
Model for a postal address.
-
identifier(optional):
object CdmIdentifier
Identifier assigned by a given system
-
name(optional):
object HumanName
Model for a name of a human with text and parts information.
-
speciality(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
-
specimenAliasIssuerFlag(optional):
string
The flag that indicates that this Service Provider has issued Specimen Alias(es).
-
telecom(optional):
object Telecom
-
type(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
Nested Schema : coding
Type:
array
Read Only:
true
Code(s) defined by a terminology system.
Show Source
-
Array of:
object Coding
Model for a reference to a code defined by a terminology system.
Nested Schema : Coding
Type:
object
Model for a reference to a code defined by a terminology system.
Show Source
-
code(optional):
string
Symbol in syntax defined by the system.
-
description(optional):
string
Description defined by the system.
-
display(optional):
string
Representation defined by the system.
-
srvcProviderId(optional):
string
Service Provider Id of Specimen Alias .
-
srvcProviderName(optional):
string
Service Provider Name of Specimen Alias .
-
sysId(optional):
string
Identity of the terminology system.
-
sysName(optional):
string
Name of the terminology system.
-
sysVersion(optional):
string
Version of the system - if relevant.
Nested Schema : CdmIdentifier
Type:
object
Identifier assigned by a given system
Show Source
-
system(optional):
string
System which assigned this identifier
-
value(optional):
string
Identifier value
Nested Schema : Location
Type:
Show Source
object
-
identifier(optional):
object CdmIdentifier
Identifier assigned by a given system
-
name(optional):
string
Name of the facility.
-
type(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
Nested Schema : Number
Type:
object
Nested Schema : Address
Type:
object
Model for a postal address.
Show Source
-
city(optional):
string
Name of city, town etc.
-
country(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
-
district(optional):
string
District name (aka county).
-
line(optional):
array line
Street name, number, direction & P.O. Box etc.
-
postalCode(optional):
string
Postal code for area.
-
state(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
Nested Schema : HumanName
Type:
object
Model for a name of a human with text and parts information.
Show Source
-
family(optional):
string
Family name (often called 'Surname').
-
given(optional):
array given
Given names (not always 'first'). Includes middle names.
-
text(optional):
string
Text representation of the full name.
Nested Schema : Telecom
Type:
Show Source
object
-
use(optional):
object CodeableConcept
Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
-
value(optional):
string
Telecom Value
Nested Schema : given
Type:
array
Given names (not always 'first'). Includes middle names.
Show Source
400 Response
Invalid parameters supplied
404 Response
Procedure not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/patientapi/procedures/10004
Example of Response Body
The following example shows the response returned in JSON format.
{ "identifier": { "system": "CDM", "value": "10004" }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/2" }, "category": { "coding": [ { "code": "PROC_CD1", "display": "Procedure Code1", "description": "Code for the procedure" } ] }, "code": { "coding": [ { "code": "PROC_CD_CODE_1", "display": "PROC_CD_CODE_NM_1", "description": "PROC_CD Code description 1", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "bodySite": { "coding": [ { "code": "ANA_SITE_CD_CODE1", "display": "ANA_SITE_CD_CODE1name", "description": "ANA_SITE_CD_CODE1Desc", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "performer": { "identifier": { "system": "CDM", "value": "SVCPRV1" }, "type": { "coding": [ { "code": "SVCPRV_TYP_CD_VALUE", "display": "SVCPRV_TYP_CD_NAME", "description": "SVCPRV_TYP_CD_DESC", "sysId": "SVCPRV_TYP_CD_SYS", "sysName": "Service Provider System", "sysVersion": "2" } ] }, "speciality": { "coding": [ { "code": "Speciality_1", "display": "SP_LTY_NAME", "description": "SP_LTY_DESC", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "specimenAliasIssuerFlag": "Y" }, "performedPeriod": { "start": "11/14/1998", "end": "12/31/1998" }, "encounter": { "identifier": { "system": "CDM", "value": "ENC1" }, "type": { "coding": [ { "code": "1", "display": "ENC_TYPE1", "description": "ENC_TYPE_DESC1", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "location": { "identifier": { "system": "CDM", "value": "1" }, "name": "FAC1", "type": { "coding": [ { "code": "FAC_SUBTYP_RM", "display": "Room", "description": "A space allocated for a function within a building or a floor", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "sequence": 10004 }, "outcome": { "coding": [ { "code": "OUTCM_CD_VIN1", "display": "OUTCM_CD_VIN_NM_1", "description": "OUTCM_CD_VIN_DESC1", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "patientcondition": { "reference": "/ohfapi/cg/v3.3/patientapi/conditions/10001" } }