Care Record API (1.0)

Download OpenAPI specification:Download

The Care Record Service HTTP API

ClinicalSummary

/ClinicalSummary/GetDiagnoses/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetProcedures/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/PostDiagnosis/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

diagnosis_id	string or null
person_id	string or null
encounter_id	string or null
operation_id	string or null
diagnosiscode	string or null
diagnosistext	string or null
statuscode	string or null
statustext	string or null
onsetdate	string or null <date-time>
enddate	string or null <date-time>
clinicalstatus	string or null
verificationstatus	string or null
resolveddate	string or null <date-time>
reportedby	string or null
clinicalsummary_id	string or null
isdateapproximate	string or null
dateeffectiveperiod	string or null
effectivedatestring	string or null

Responses

Request samples

Payload

Content type

application/json

{"diagnosis_id": "string",
"person_id": "string",
"encounter_id": "string",
"operation_id": "string",
"diagnosiscode": "string",
"diagnosistext": "string",
"statuscode": "string",
"statustext": "string",
"onsetdate": "2019-08-24T14:15:22Z",
"enddate": "2019-08-24T14:15:22Z",
"clinicalstatus": "string",
"verificationstatus": "string",
"resolveddate": "2019-08-24T14:15:22Z",
"reportedby": "string",
"clinicalsummary_id": "string",
"isdateapproximate": "string",
"dateeffectiveperiod": "string",
"effectivedatestring": "string"
}

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/PostProcedure/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

procedure_id	string or null
proceduredate	string or null <date-time>
duration	integer or null <int32>
person_id	string or null
encounter_id	string or null
isprimary	boolean or null
operation_id	string or null
name	string or null
anaesthesiacode	string or null
proceduremodifiercode	string or null
proceduremodifiertext	string or null
setid	integer or null <int32>
anaesthesiaminutes	number or null <float>
status	string or null
code	string or null
performedby	string or null
clinicalsummary_id	string or null
isdateapproximate	string or null
dateeffectiveperiod	string or null
effectivedatestring	string or null

Responses

Request samples

Payload

Content type

application/json

{"procedure_id": "string",
"proceduredate": "2019-08-24T14:15:22Z",
"duration": 0,
"person_id": "string",
"encounter_id": "string",
"isprimary": true,
"operation_id": "string",
"name": "string",
"anaesthesiacode": "string",
"proceduremodifiercode": "string",
"proceduremodifiertext": "string",
"setid": 0,
"anaesthesiaminutes": 0,
"status": "string",
"code": "string",
"performedby": "string",
"clinicalsummary_id": "string",
"isdateapproximate": "string",
"dateeffectiveperiod": "string",
"effectivedatestring": "string"
}

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetLabResults/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

[["string"
]
]

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetSepsisChartList/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/PostClinicalSummaryNotes/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

clinicalsummarynotes_id	string or null
notes	string or null
person_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"clinicalsummarynotes_id": "string",
"notes": "string",
"person_id": "string"
}

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/PostInvestigation/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

investigation_id	string or null
clinicalinvestigationnotes	string or null
person_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"investigation_id": "string",
"clinicalinvestigationnotes": "string",
"person_id": "string"
}

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/PostDischargePlan/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

dischargeplan_id	string or null
dischargeplannotes	string or null
person_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"dischargeplan_id": "string",
"dischargeplannotes": "string",
"person_id": "string"
}

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/PostTask/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

task_id	string or null
correlationid	string or null
correlationtype	string or null
person_id	string or null
tasktype	string or null
taskdetails	string or null
taskcreatedby	string or null
taskcreateddatetime	string or null <date-time>
taskname	string or null
allocatedto	string or null
notes	string or null
priority	string or null
status	string or null
owner	string or null
encounter_id	string or null
duedate	string or null <date-time>
allocateddatetime	string or null <date-time>
ownerassigneddatetime	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"task_id": "string",
"correlationid": "string",
"correlationtype": "string",
"person_id": "string",
"tasktype": "string",
"taskdetails": "string",
"taskcreatedby": "string",
"taskcreateddatetime": "2019-08-24T14:15:22Z",
"taskname": "string",
"allocatedto": "string",
"notes": "string",
"priority": "string",
"status": "string",
"owner": "string",
"encounter_id": "string",
"duedate": "2019-08-24T14:15:22Z",
"allocateddatetime": "2019-08-24T14:15:22Z",
"ownerassigneddatetime": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetDiagnosisHistory/{diagnosisId}

Authorizations:

oauth2

path Parameters

diagnosisId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetProcedureHistory/{procedureId}

Authorizations:

oauth2

path Parameters

procedureId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetTaskHistory/{taskId}

Authorizations:

oauth2

path Parameters

taskId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetClinicalSummaryNotesHistory/{clinicalSummaryNotesId}

Authorizations:

oauth2

path Parameters

clinicalSummaryNotesId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetInvestigationHistory/{investigationId}

Authorizations:

oauth2

path Parameters

investigationId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetDischargePlanHistory/{dischargeplanId}

Authorizations:

oauth2

path Parameters

dischargeplanId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetClinicalSummaryNote/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetDischargePlan/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetInvestigation/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetTasks/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetClinicalSummaryStatuses/{type}

Authorizations:

oauth2

path Parameters

type

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/ClinicalSummary/GetProviders

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

FhirGeneric

/fhir/{type}/{id}

Authorizations:

oauth2

path Parameters

type required	string
id required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/fhir/{type}/{id}/{versionId}

Authorizations:

oauth2

path Parameters

type required	string
id required	string
versionId required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/fhir/{type}

Authorizations:

oauth2

path Parameters

type

required

string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/fhir/$GetStructuredRecord

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
400
404
410

Content type

text/plain

No sample

FhirPlayground

/fhirplayground/v1/Observation/{personId}

path Parameters

personId

required

string

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/fhirplayground/v1/{type}/{id}

path Parameters

type required	string
id required	string

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/fhirplayground/v1/observation

Request Body schema:
application/json

	object (ObservationEventDTO)
	Array of objects or null (ObservationDTO)

Responses

Request samples

Payload

Content type

application/json

{"observationEvent": {"observationevent_Id": "string",
"rowId": "string",
"sequenceid": 0,
"contextkey": "string",
"createdtimestamp": "2019-08-24T14:15:22Z",
"createddate": "2019-08-24T14:15:22Z",
"createdsource": "string",
"createdmessageid": "string",
"_Createdby": "string",
"recordstatus": 0,
"timezonename": "string",
"timezoneoffset": 0,
"tenant": "string",
"person_Id": "string",
"datestarted": "2019-08-24T14:15:22Z",
"datefinished": "2019-08-24T14:15:22Z",
"addedby": "string",
"encounter_Id": "string",
"isamended": true,
"observationfrequency": 0,
"observationscaletype_Id": "string",
"escalationofcare": true,
"reasonforamend": "string",
"reasonfordelete": "string",
"reasonforincompleteobservations": "string",
"eventcorrelationid": "string"
},
"observations": [{"observation_Id": "string",
"rowId": "string",
"sequenceid": 0,
"contextkey": "string",
"createdtimestamp": "2019-08-24T14:15:22Z",
"createddate": "2019-08-24T14:15:22Z",
"createdsource": "string",
"createdmessageid": "string",
"_Createdby": "string",
"recordstatus": 0,
"timezonename": "string",
"timezoneoffset": 0,
"tenant": "string",
"units": "string",
"symbol": "string",
"timerecorded": "2019-08-24T14:15:22Z",
"observationevent_Id": "string",
"observationtype_Id": "string",
"observationtypemeasurement_Id": "string",
"value": null,
"hasbeenammended": true,
"eventcorrelationid": "string"
}
]
}

Response samples

200

Content type

text/plain

No sample

FluidBalance

/FluidBalance/GetHelloWorld

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/FluidBalance/AddUpdateRemoveSingleVolumeObservation/{personId}/{encounterId}

Authorizations:

oauth2

path Parameters

personId required	string
encounterId required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

fluidbalanceintakeoutput_id	string or null
fluidbalancesessionroute_id	string or null
route_id	string or null
routetype_id	string or null
expectedvolume	number <float>
volume	number <float>
units	string or null
datetime	string or null
fluidcapturedevice_id	string or null
fluidbalanceiotype_id	string or null
isamended	boolean
reasonforamend	string or null
reasonforremoval	string or null
isremoved	boolean
personweight	number <float>
person_id	string or null
addedby	string or null
modifiedby	string or null
continuousinfusionevent_id	string or null
continuousinfusionvalidation_id	string or null
isintake	boolean
fluidbalancesession_id	string or null
continuousinfusion_id	string or null
otherroutetype	string or null

Responses

Request samples

Payload

Content type

application/json

{"fluidbalanceintakeoutput_id": "string",
"fluidbalancesessionroute_id": "string",
"route_id": "string",
"routetype_id": "string",
"expectedvolume": 0,
"volume": 0,
"units": "string",
"datetime": "string",
"fluidcapturedevice_id": "string",
"fluidbalanceiotype_id": "string",
"isamended": true,
"reasonforamend": "string",
"reasonforremoval": "string",
"isremoved": true,
"personweight": 0,
"person_id": "string",
"addedby": "string",
"modifiedby": "string",
"continuousinfusionevent_id": "string",
"continuousinfusionvalidation_id": "string",
"isintake": true,
"fluidbalancesession_id": "string",
"continuousinfusion_id": "string",
"otherroutetype": "string"
}

Response samples

200

Content type

text/plain

No sample

/FluidBalance/AddSessionRoute

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

fluidbalancesessionroute_id	string or null
fluidbalancesession_id	string or null
route_id	string or null
hasbeenamended	boolean
dateadded	string or null
displayorder	integer <int32>
addedby	string or null
modifiedby	string or null
routename	string or null
isintake	boolean

Responses

Request samples

Payload

Content type

application/json

{"fluidbalancesessionroute_id": "string",
"fluidbalancesession_id": "string",
"route_id": "string",
"hasbeenamended": true,
"dateadded": "string",
"displayorder": 0,
"addedby": "string",
"modifiedby": "string",
"routename": "string",
"isintake": true
}

Response samples

200

Content type

text/plain

No sample

/FluidBalance/GetSession/{personId}/{encounterId}/{startDate}

Authorizations:

oauth2

path Parameters

personId required	string
encounterId required	string
startDate required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/FluidBalance/GetSessionWithCreate/{personId}/{encounterId}/{startDate}/{userId}/{stopDate}

Authorizations:

oauth2

path Parameters

personId required	string
encounterId required	string
startDate required	string
userId required	string
stopDate required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/FluidBalance/SetMonitoringStatus

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

fluidbalancepersonstatus_id	string or null
person_id	string or null
encounter_id	string or null
isactive	boolean
addedby	string or null
modifiedby	string or null

Responses

Request samples

Payload

Content type

application/json

{"fluidbalancepersonstatus_id": "string",
"person_id": "string",
"encounter_id": "string",
"isactive": true,
"addedby": "string",
"modifiedby": "string"
}

Response samples

200

Content type

text/plain

No sample

/FluidBalance/GetUrineOutputHistoryForSession/{personId}/{fluidBalanceSessionId}/{fluidBalanceSessionRouteId}/{routeId}

Authorizations:

oauth2

path Parameters

personId required	string
fluidBalanceSessionId required	string
fluidBalanceSessionRouteId required	string
routeId required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/FluidBalance/CalculateExpectedUrineOutput/{personId}/{encounterId}

Authorizations:

oauth2

path Parameters

personId required	string
encounterId required	string

query Parameters

api-version

string

Default: "1.0"

The requested API version

Responses

Response samples

200

Content type

text/plain

No sample

/FluidBalance/AddFlushToContinuousInfusion

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

any

Responses

Request samples

Payload

Content type

application/json

[null
]

Response samples

200

Content type

text/plain

No sample

/FluidBalance/AddBolusToContinuousInfusion

Authorizations:

oauth2

query Parameters

api-version

string

Default: "1.0"

The requested API version

Request Body schema:
application/json

Array

any

Responses

Request samples

Payload

Content type

application/json

[null
]

Response samples

200

Content type

text/plain

No sample

Synapse

/synapse/v1/observation/{personId}

Authorizations:

oauth2

path Parameters

personId

required

string

Responses

Response samples

200
404
410

Content type

text/plain

No sample

/synapse/v1/observation

Authorizations:

oauth2

Request Body schema:
application/json

	object (ObservationEventDTO)
	Array of objects or null (ObservationDTO)

Responses

Request samples

Payload

Content type

application/json

{"observationEvent": {"observationevent_Id": "string",
"rowId": "string",
"sequenceid": 0,
"contextkey": "string",
"createdtimestamp": "2019-08-24T14:15:22Z",
"createddate": "2019-08-24T14:15:22Z",
"createdsource": "string",
"createdmessageid": "string",
"_Createdby": "string",
"recordstatus": 0,
"timezonename": "string",
"timezoneoffset": 0,
"tenant": "string",
"person_Id": "string",
"datestarted": "2019-08-24T14:15:22Z",
"datefinished": "2019-08-24T14:15:22Z",
"addedby": "string",
"encounter_Id": "string",
"isamended": true,
"observationfrequency": 0,
"observationscaletype_Id": "string",
"escalationofcare": true,
"reasonforamend": "string",
"reasonfordelete": "string",
"reasonforincompleteobservations": "string",
"eventcorrelationid": "string"
},
"observations": [{"observation_Id": "string",
"rowId": "string",
"sequenceid": 0,
"contextkey": "string",
"createdtimestamp": "2019-08-24T14:15:22Z",
"createddate": "2019-08-24T14:15:22Z",
"createdsource": "string",
"createdmessageid": "string",
"_Createdby": "string",
"recordstatus": 0,
"timezonename": "string",
"timezoneoffset": 0,
"tenant": "string",
"units": "string",
"symbol": "string",
"timerecorded": "2019-08-24T14:15:22Z",
"observationevent_Id": "string",
"observationtype_Id": "string",
"observationtypemeasurement_Id": "string",
"value": null,
"hasbeenammended": true,
"eventcorrelationid": "string"
}
]
}

Response samples

200

Content type

text/plain

No sample

Care Record API (1.0)

ClinicalSummary

/ClinicalSummary/GetDiagnoses/{personId}

Authorizations:

path Parameters

query Parameters

Responses

Response samples

/ClinicalSummary/GetProcedures/{personId}

Authorizations:

path Parameters

query Parameters

Responses

Response samples

/ClinicalSummary/PostDiagnosis/{personId}

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/json

Responses

Request samples

Response samples

/ClinicalSummary/PostProcedure/{personId}

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/json

Responses

Request samples

Response samples

/ClinicalSummary/GetLabResults/{personId}

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/json

Responses

Request samples

Response samples

/ClinicalSummary/GetSepsisChartList/{personId}

Authorizations:

path Parameters

query Parameters

Responses

Response samples

/ClinicalSummary/PostClinicalSummaryNotes/{personId}

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/json

Responses

Request samples

Response samples

/ClinicalSummary/PostInvestigation/{personId}

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/json

Responses

Request samples

Response samples

/ClinicalSummary/PostDischargePlan/{personId}

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/json

Responses

Request samples

Response samples

/ClinicalSummary/PostTask/{personId}

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/json

Responses

Request samples

Response samples

/ClinicalSummary/GetDiagnosisHistory/{diagnosisId}

Authorizations:

path Parameters

query Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json