Connectors Reference

FHIRBase

Microsoft FHIR Server Connector for FHIR R4 Base resources.

 

Status: Preview

Tier: Premium

Version: 4.0.1

 

Actions:

Name

Summary

GET_Appointment ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string patient, [Optional]string _count, [Optional]string _sort)

Get Appointment

POST_Appointment ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_AppointmentParameterBody body)

Post Appointment

GET_Appointment_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Appointment ID

DELETE_Appointment_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Appointment_IDParameterBody body)

Delete Appointment ID

PUT_Appointment_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Appointment_IDParameterBody body)

Put Appointment ID

GET_Appointment_ID_VERSION (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Appointment ID History

GET_Appointment_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Appointment ID History

GET_Appointment_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string patient)

Get Appointment History

GET_AppointmentResponse ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Appointment Response

POST_AppointmentResponse ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_AppointmentResponseParameterBody body)

Post Appointment Response

GET_AppointmentResponse_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Post Appointment Response ID

DELETE_AppointmentResponse_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_AppointmentResponse_IDParameterBody body)

Delete AppointmentResponse ID

PUT_AppointmentResponse_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_AppointmentResponse_IDParameterBody body)

Put AppointmentResponse ID

GET_AppointmentResponse_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get AppointmentResponse ID Version

GET_AppointmentResponse_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Appointment History

GET_AppointmentResponse_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Appointment Response History

GET_Device ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Get Device

POST_Device ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_DeviceParameterBody body)

Post Device

GET_Device_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Device ID

DELETE_Device_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Device_IDParameterBody body)

Delete Device ID

PUT_Device_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Device_IDParameterBody body)

Put Device ID

GET_Device_ID_VERSION (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Device ID Version

GET_Device_ID_HISTORY (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Device ID History

GET_Device_HISTORY ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Device History

GET_Encounter ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Get Encounter

POST_Encounter ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_EncounterParameterBody body)

Post Encounter

GET_Encounter_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Encounter ID

DELETE_Encounter_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Encounter_IDParameterBody body)

Delete Encounter ID

PUT_Encounter_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Encounter_IDParameterBody body)

Put Encounter ID

GET_Encounter_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Encounter ID Version

GET_Encounter_ID_HISTORY (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Encounter ID History

GET_Encounter_HISTORY ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Enouncter History

GET_Flag ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Get Flag

POST_FLAG ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_FLAGParameterBody body)

Post Flag

GET_Flag_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Flag ID

DELETE_Flag_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Flag_IDParameterBody body)

DELETE Flag ID

PUT_Flag_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Flag_IDParameterBody body)

Put Flag ID

GET_Flag_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Flag ID Version

GET_Flag_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Flag ID History

GET_Flag_HISTORY ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Flag History

GET_Location ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Get Location

POST_Location ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_LocationParameterBody body)

Post Location

GET_Location_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Location ID

DELETE_Location_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Location_IDParameterBody body)

Delete Location ID

PUT_Location_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Location_IDParameterBody body)

Put Location ID

GET_Location_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Location Version

GET_Location_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Location ID History

GET_Location_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Location History

GET_Patient ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Get Patient

POST_Patient ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_PatientParameterBody body)

Post Patient

GET_Patient_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Patient ID

DELETE_Patient_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Patient_IDParameterBody body)

Delete Patient ID

PUT_Patient_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Patient_IDParameterBody body)

Put Patient ID

GET_Patient_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Patient ID Version

GET_Patient_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Patient ID History

GET_Patient_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Patient History

GET_Person ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Get Person

POST_Person ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_PersonParameterBody body)

Post Person

GET_Person_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Person ID

DELETE_Person_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Person_IDParameterBody body)

Delete Person ID

PUT_Person_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Person_IDParameterBody body)

Put Person ID

GET_Person_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Person ID Version

GET_Person_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Person ID History

GET_Person_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Person History

GET_Practitioner ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

Get Practitioner

POST_Practitioner ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_PractitionerParameterBody body)

Post Practitioner

GET_Practitioner_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Practitioner ID

DELETE_Practitioner_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Practitioner_IDParameterBody body)

Delete Practitioner ID

PUT_Practitioner_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Practitioner_IDParameterBody body)

Put Practitioner ID

GET_Practitioner_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Practitioner ID Version

GET_Practitioner_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Pracitioner ID History

GET_Practitioner_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

Get Practitioner History

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

DELETE_AppointmentResponse_IDParameterBody

 

DELETE_AppointmentResponse_IDResponse

 

DELETE_Appointment_IDParameterBody

 

DELETE_Appointment_IDResponse

 

DELETE_Device_IDParameterBody

 

DELETE_Device_IDResponse

 

DELETE_Encounter_IDParameterBody

 

DELETE_Encounter_IDResponse

 

DELETE_Flag_IDParameterBody

 

DELETE_Flag_IDResponse

 

DELETE_Location_IDParameterBody

 

DELETE_Location_IDResponse

 

DELETE_Patient_IDParameterBody

 

DELETE_Patient_IDResponse

 

DELETE_Person_IDParameterBody

 

DELETE_Person_IDResponse

 

DELETE_Practitioner_IDParameterBody

 

DELETE_Practitioner_IDResponse

 

GET_AppointmentResponse

 

GET_AppointmentResponseResponse

 

GET_AppointmentResponse_HistoryResponse

 

GET_AppointmentResponse_IDResponse

 

GET_AppointmentResponse_ID_HistoryResponse

 

GET_AppointmentResponse_ID_VersionResponse

 

GET_Appointment_HistoryResponse

 

GET_Appointment_IDResponse

 

GET_Appointment_ID_HistoryResponse

 

GET_Appointment_ID_VERSIONResponse

 

GET_DeviceResponse

 

GET_Device_HISTORYResponse

 

GET_Device_IDResponse

 

GET_Device_ID_HISTORYResponse

 

GET_Device_ID_VERSIONResponse

 

GET_EncounterResponse

 

GET_Encounter_HISTORYResponse

 

GET_Encounter_IDResponse

 

GET_Encounter_ID_HISTORYResponse

 

GET_Encounter_ID_VersionResponse

 

GET_FlagResponse

 

GET_Flag_HISTORYResponse

 

GET_Flag_IDResponse

 

GET_Flag_ID_HistoryResponse

 

GET_Flag_ID_VersionResponse

 

GET_LocationResponse

 

GET_Location_HistoryResponse

 

GET_Location_IDResponse

 

GET_Location_ID_HistoryResponse

 

GET_Location_ID_VersionResponse

 

GET_PatientResponse

 

GET_Patient_HistoryResponse

 

GET_Patient_IDResponse

 

GET_Patient_ID_HistoryResponse

 

GET_Patient_ID_VersionResponse

 

GET_PersonResponse

 

GET_Person_HistoryResponse

 

GET_Person_IDResponse

 

GET_Person_ID_HistoryResponse

 

GET_Person_ID_VersionResponse

 

GET_PractitionerResponse

 

GET_Practitioner_HistoryResponse

 

GET_Practitioner_IDResponse

 

GET_Practitioner_ID_HistoryResponse

 

GET_Practitioner_ID_VersionResponse

 

POST_AppointmentParameterBody

 

POST_AppointmentResponse

 

POST_AppointmentResponseParameterBody

 

POST_AppointmentResponseResponse

 

POST_DeviceParameterBody

 

POST_DeviceResponse

 

POST_EncounterParameterBody

 

POST_EncounterResponse

 

POST_FLAGParameterBody

 

POST_FLAGResponse

 

POST_LocationParameterBody

 

POST_LocationResponse

 

POST_PatientParameterBody

 

POST_PatientResponse

 

POST_PersonParameterBody

 

POST_PersonResponse

 

POST_PractitionerParameterBody

 

POST_PractitionerResponse

 

PUT_AppointmentResponse_IDParameterBody

 

PUT_AppointmentResponse_IDResponse

 

PUT_Appointment_IDParameterBody

 

PUT_Appointment_IDResponse

 

PUT_Device_IDParameterBody

 

PUT_Device_IDResponse

 

PUT_Encounter_IDParameterBody

 

PUT_Encounter_IDResponse

 

PUT_Flag_IDParameterBody

 

PUT_Flag_IDResponse

 

PUT_Location_IDParameterBody

 

PUT_Location_IDResponse

 

PUT_Patient_IDParameterBody

 

PUT_Patient_IDResponse

 

PUT_Person_IDParameterBody

 

PUT_Person_IDResponse

 

PUT_Practitioner_IDParameterBody

 

PUT_Practitioner_IDResponse

 

 

Actions:

GET_Appointment

Summary: Get Appointment

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.GET_Appointment ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string patient, [Optional]string _count, [Optional]string _sort)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

patient

string

(search)

clinical-patient

False

_count

string

(count)

choose to return the results in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

 

Returns:

          Type:GET_AppointmentResponse

 

POST_Appointment

Summary: Post Appointment

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.POST_Appointment ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_AppointmentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_AppointmentParameterBody

 

 

False

 

Returns:

          Type:POST_AppointmentResponse

 

GET_Appointment_ID

Summary: Get Appointment ID

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.GET_Appointment_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Appointment_IDResponse

 

DELETE_Appointment_ID

Summary: Delete Appointment ID

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.DELETE_Appointment_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Appointment_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Appointment_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Appointment_IDResponse

 

PUT_Appointment_ID

Summary: Put Appointment ID

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.PUT_Appointment_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Appointment_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Appointment_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Appointment_IDResponse

 

GET_Appointment_ID_VERSION

Summary: Get Appointment ID History

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.GET_Appointment_ID_VERSION (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Appointment_ID_VERSIONResponse

 

GET_Appointment_ID_History

Summary: Get Appointment ID History

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.GET_Appointment_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Appointment_ID_HistoryResponse

 

GET_Appointment_History

Summary: Get Appointment History

Description: A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

 

Syntax:

FHIRBase.GET_Appointment_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_Appointment_HistoryResponse

 

GET_AppointmentResponse

Summary: Appointment Response

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.GET_AppointmentResponse ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_AppointmentResponseResponse

 

POST_AppointmentResponse

Summary: Post Appointment Response

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.POST_AppointmentResponse ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_AppointmentResponseParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_AppointmentResponseParameterBody

 

 

False

 

Returns:

          Type:POST_AppointmentResponseResponse

 

GET_AppointmentResponse_ID

Summary: Post Appointment Response ID

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.GET_AppointmentResponse_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_AppointmentResponse_IDResponse

 

DELETE_AppointmentResponse_ID

Summary: Delete AppointmentResponse ID

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.DELETE_AppointmentResponse_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_AppointmentResponse_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_AppointmentResponse_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_AppointmentResponse_IDResponse

 

PUT_AppointmentResponse_ID

Summary: Put AppointmentResponse ID

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.PUT_AppointmentResponse_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_AppointmentResponse_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_AppointmentResponse_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_AppointmentResponse_IDResponse

 

GET_AppointmentResponse_ID_Version

Summary: Get AppointmentResponse ID Version

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.GET_AppointmentResponse_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_AppointmentResponse_ID_VersionResponse

 

GET_AppointmentResponse_ID_History

Summary: Get Appointment History

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.GET_AppointmentResponse_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_AppointmentResponse_ID_HistoryResponse

 

GET_AppointmentResponse_History

Summary: Get Appointment Response History

Description: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

 

Syntax:

FHIRBase.GET_AppointmentResponse_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_AppointmentResponse_HistoryResponse

 

GET_Device

Summary: Get Device

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.GET_Device ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(patient query)

One of the individuals of the appointment is this patient

False

 

Returns:

          Type:GET_DeviceResponse

 

POST_Device

Summary: Post Device

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.POST_Device ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_DeviceParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_DeviceParameterBody

 

 

False

 

Returns:

          Type:POST_DeviceResponse

 

GET_Device_ID

Summary: Get Device ID

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.GET_Device_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Device_IDResponse

 

DELETE_Device_ID

Summary: Delete Device ID

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.DELETE_Device_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Device_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Device_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Device_IDResponse

 

PUT_Device_ID

Summary: Put Device ID

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.PUT_Device_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Device_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Device_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Device_IDResponse

 

GET_Device_ID_VERSION

Summary: Get Device ID Version

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.GET_Device_ID_VERSION (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Device_ID_VERSIONResponse

 

GET_Device_ID_HISTORY

Summary: Get Device ID History

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.GET_Device_ID_HISTORY (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Device_ID_HISTORYResponse

 

GET_Device_HISTORY

Summary: Get Device History

Description: A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

 

Syntax:

FHIRBase.GET_Device_HISTORY ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Device_HISTORYResponse

 

GET_Encounter

Summary: Get Encounter

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.GET_Encounter ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_EncounterResponse

 

POST_Encounter

Summary: Post Encounter

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.POST_Encounter ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_EncounterParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_EncounterParameterBody

 

 

False

 

Returns:

          Type:POST_EncounterResponse

 

GET_Encounter_ID

Summary: Get Encounter ID

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.GET_Encounter_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Encounter_IDResponse

 

DELETE_Encounter_ID

Summary: Delete Encounter ID

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.DELETE_Encounter_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Encounter_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Encounter_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Encounter_IDResponse

 

PUT_Encounter_ID

Summary: Put Encounter ID

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.PUT_Encounter_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Encounter_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Encounter_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Encounter_IDResponse

 

GET_Encounter_ID_Version

Summary: Get Encounter ID Version

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.GET_Encounter_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Encounter_ID_VersionResponse

 

GET_Encounter_ID_HISTORY

Summary: Get Encounter ID History

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.GET_Encounter_ID_HISTORY (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Encounter_ID_HISTORYResponse

 

GET_Encounter_HISTORY

Summary: Get Enouncter History

Description: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

 

Syntax:

FHIRBase.GET_Encounter_HISTORY ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Encounter_HISTORYResponse

 

GET_Flag

Summary: Get Flag

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.GET_Flag ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_FlagResponse

 

POST_FLAG

Summary: Post Flag

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.POST_FLAG ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_FLAGParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_FLAGParameterBody

 

 

False

 

Returns:

          Type:POST_FLAGResponse

 

GET_Flag_ID

Summary: Get Flag ID

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.GET_Flag_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Flag_IDResponse

 

DELETE_Flag_ID

Summary: DELETE Flag ID

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.DELETE_Flag_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Flag_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Flag_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Flag_IDResponse

 

PUT_Flag_ID

Summary: Put Flag ID

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.PUT_Flag_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Flag_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Flag_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Flag_IDResponse

 

GET_Flag_ID_Version

Summary: Get Flag ID Version

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.GET_Flag_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Flag_ID_VersionResponse

 

GET_Flag_ID_History

Summary: Get Flag ID History

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.GET_Flag_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Flag_ID_HistoryResponse

 

GET_Flag_HISTORY

Summary: Get Flag History

Description: Prospective warnings of potential issues when providing care to the patient.

 

Syntax:

FHIRBase.GET_Flag_HISTORY ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Flag_HISTORYResponse

 

GET_Location

Summary: Get Location

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.GET_Location ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_LocationResponse

 

POST_Location

Summary: Post Location

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.POST_Location ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_LocationParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_LocationParameterBody

 

 

False

 

Returns:

          Type:POST_LocationResponse

 

GET_Location_ID

Summary: Get Location ID

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.GET_Location_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Location_IDResponse

 

DELETE_Location_ID

Summary: Delete Location ID

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.DELETE_Location_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Location_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Location_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Location_IDResponse

 

PUT_Location_ID

Summary: Put Location ID

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.PUT_Location_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Location_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Location_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Location_IDResponse

 

GET_Location_ID_Version

Summary: Get Location Version

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.GET_Location_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Location_ID_VersionResponse

 

GET_Location_ID_History

Summary: Get Location ID History

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.GET_Location_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Location_ID_HistoryResponse

 

GET_Location_History

Summary: Get Location History

Description: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

 

Syntax:

FHIRBase.GET_Location_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Location_HistoryResponse

 

GET_Patient

Summary: Get Patient

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.GET_Patient ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_PatientResponse

 

POST_Patient

Summary: Post Patient

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.POST_Patient ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_PatientParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_PatientParameterBody

 

 

False

 

Returns:

          Type:POST_PatientResponse

 

GET_Patient_ID

Summary: Get Patient ID

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.GET_Patient_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Patient_IDResponse

 

DELETE_Patient_ID

Summary: Delete Patient ID

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.DELETE_Patient_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Patient_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Patient_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Patient_IDResponse

 

PUT_Patient_ID

Summary: Put Patient ID

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.PUT_Patient_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Patient_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Patient_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Patient_IDResponse

 

GET_Patient_ID_Version

Summary: Get Patient ID Version

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.GET_Patient_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Patient_ID_VersionResponse

 

GET_Patient_ID_History

Summary: Get Patient ID History

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.GET_Patient_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Patient_ID_HistoryResponse

 

GET_Patient_History

Summary: Get Patient History

Description: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

 

Syntax:

FHIRBase.GET_Patient_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Patient_HistoryResponse

 

GET_Person

Summary: Get Person

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.GET_Person ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_PersonResponse

 

POST_Person

Summary: Post Person

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.POST_Person ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_PersonParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_PersonParameterBody

 

 

False

 

Returns:

          Type:POST_PersonResponse

 

GET_Person_ID

Summary: Get Person ID

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.GET_Person_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Person_IDResponse

 

DELETE_Person_ID

Summary: Delete Person ID

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.DELETE_Person_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Person_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Person_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Person_IDResponse

 

PUT_Person_ID

Summary: Put Person ID

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.PUT_Person_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Person_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Person_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Person_IDResponse

 

GET_Person_ID_Version

Summary: Get Person ID Version

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.GET_Person_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Person_ID_VersionResponse

 

GET_Person_ID_History

Summary: Get Person ID History

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.GET_Person_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Person_ID_HistoryResponse

 

GET_Person_History

Summary: Get Person History

Description: Demographics and administrative information about a person independent of a specific health-related context.

 

Syntax:

FHIRBase.GET_Person_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Person_HistoryResponse

 

GET_Practitioner

Summary: Get Practitioner

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.GET_Practitioner ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]string _count, [Optional]string _sort, [Optional]string patient)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

_count

string

(count)

results returned in a series of pages

False

_sort

string

(sort)

order to return the results by using the parameter

False

patient

string

(search)

clinical-patient

False

 

Returns:

          Type:GET_PractitionerResponse

 

POST_Practitioner

Summary: Post Practitioner

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.POST_Practitioner ([internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]POST_PractitionerParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

body

POST_PractitionerParameterBody

 

 

False

 

Returns:

          Type:POST_PractitionerResponse

 

GET_Practitioner_ID

Summary: Get Practitioner ID

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.GET_Practitioner_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Practitioner_IDResponse

 

DELETE_Practitioner_ID

Summary: Delete Practitioner ID

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.DELETE_Practitioner_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]DELETE_Practitioner_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

DELETE_Practitioner_IDParameterBody

 

 

False

 

Returns:

          Type:DELETE_Practitioner_IDResponse

 

PUT_Practitioner_ID

Summary: Put Practitioner ID

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.PUT_Practitioner_ID (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept, [Optional]PUT_Practitioner_IDParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

body

PUT_Practitioner_IDParameterBody

 

 

False

 

Returns:

          Type:PUT_Practitioner_IDResponse

 

GET_Practitioner_ID_Version

Summary: Get Practitioner ID Version

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.GET_Practitioner_ID_Version (string id, string vid, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

vid

string

(history)

Changes made to the Value Set Definition over time

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Practitioner_ID_VersionResponse

 

GET_Practitioner_ID_History

Summary: Get Pracitioner ID History

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.GET_Practitioner_ID_History (string id, [internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

logical id of the resource

True

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Practitioner_ID_HistoryResponse

 

GET_Practitioner_History

Summary: Get Practitioner History

Description: A person who is directly or indirectly involved in the provisioning of healthcare.

 

Syntax:

FHIRBase.GET_Practitioner_History ([internal][Optional]string Content-Type, [internal][Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

False

Accept

string

 

 

False

 

Returns:

          Type:GET_Practitioner_HistoryResponse

 


 

DELETE_AppointmentResponse_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

text

Text

 

text

appointment

Appointment

 

appointment

actor

Actor

 

actor

participantStatus

string

 

participantStatus

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

Appointment

Summary:

Description: appointment

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

Actor

Summary:

Description: actor

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_AppointmentResponse_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

text

Text

 

text

appointment

Appointment

 

appointment

actor

Actor

 

actor

participantStatus

string

 

participantStatus

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

Appointment

Summary:

Description: appointment

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

Actor

Summary:

Description: actor

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Appointment_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

text

Text

 

text

status

string

 

status

participant

array of (ParticipantItem)

 

participant

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

ParticipantItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

actor

Actor

 

actor

required

string

 

required

status

string

 

status

type

array of (TypeItem)

 

type

 

Actor

Summary:

Description: actor

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

TypeItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

 


 

DELETE_Appointment_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

text

Text

 

text

status

string

 

status

participant

array of (ParticipantItem)

 

participant

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

ParticipantItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

actor

Actor

 

actor

required

string

 

required

status

string

 

status

type

array of (TypeItem)

 

type

 

Actor

Summary:

Description: actor

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

TypeItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

 


 

DELETE_Device_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

text

Text

 

text

identifier

array of (IdentifierItem)

 

identifier

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

IdentifierItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

value

string

 

value

 


 

DELETE_Device_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

text

Text

 

text

identifier

array of (IdentifierItem)

 

identifier

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

IdentifierItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

value

string

 

value

 


 

DELETE_Encounter_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

status

string

 

status

class

Class

 

class

type

array of (TypeItem)

 

type

subject

Subject

 

subject

participant

array of (ParticipantItem)

 

participant

period

Period

 

period

serviceProvider

ServiceProvider

 

serviceProvider

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Class

Summary:

Description: class

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

 

TypeItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

text

string

 

text

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

display

string

 

display

 

Subject

Summary:

Description: subject

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

ParticipantItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

individual

Individual

 

individual

 

Individual

Summary:

Description: individual

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

Period

Summary:

Description: period

 

          Properties:

Name

Type

Summary

start

string

 

start

end

string

 

end

 

ServiceProvider

Summary:

Description: serviceProvider

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Encounter_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

status

string

 

status

class

Class

 

class

type

array of (TypeItem)

 

type

subject

Subject

 

subject

participant

array of (ParticipantItem)

 

participant

period

Period

 

period

serviceProvider

ServiceProvider

 

serviceProvider

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

Class

Summary:

Description: class

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

 

TypeItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

text

string

 

text

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

display

string

 

display

 

Subject

Summary:

Description: subject

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

ParticipantItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

individual

Individual

 

individual

 

Individual

Summary:

Description: individual

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

Period

Summary:

Description: period

 

          Properties:

Name

Type

Summary

start

string

 

start

end

string

 

end

 

ServiceProvider

Summary:

Description: serviceProvider

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Flag_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

text

Text

 

text

identifier

array of (IdentifierItem)

 

identifier

status

string

 

status

category

array of (CategoryItem)

 

category

code

Code

 

code

subject

Subject

 

subject

period

Period

 

period

author

Author

 

author

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

IdentifierItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

 

value

 

CategoryItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

text

string

 

text

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

display

string

 

display

 

Code

Summary:

Description: code

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

text

string

 

text

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

display

string

 

display

 

Subject

Summary:

Description: subject

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

Period

Summary:

Description: period

 

          Properties:

Name

Type

Summary

start

string

 

start

end

string

 

end

 

Author

Summary:

Description: author

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Flag_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

text

Text

 

text

identifier

array of (IdentifierItem)

 

identifier

status

string

 

status

category

array of (CategoryItem)

 

category

code

Code

 

code

subject

Subject

 

subject

period

Period

 

period

author

Author

 

author

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

IdentifierItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

 

value

 

CategoryItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

text

string

 

text

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

display

string

 

display

 

Code

Summary:

Description: code

 

          Properties:

Name

Type

Summary

coding

array of (CodingItem)

 

coding

text

string

 

text

 

CodingItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

code

string

 

code

display

string

 

display

 

Subject

Summary:

Description: subject

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

Period

Summary:

Description: period

 

          Properties:

Name

Type

Summary

start

string

 

start

end

string

 

end

 

Author

Summary:

Description: author

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Location_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

text

Text

 

text

status

string

 

status

name

string

 

name

mode

string

 

mode

partOf

PartOf

 

partOf

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

PartOf

Summary:

Description: partOf

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Location_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

text

Text

 

text

status

string

 

status

name

string

 

name

mode

string

 

mode

partOf

PartOf

 

partOf

 

Text

Summary:

Description: text

 

          Properties:

Name

Type

Summary

status

string

 

status

div

string

 

div

 

PartOf

Summary:

Description: partOf

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Patient_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

active

boolean

 

active

name

array of (NameItem)

 

name

telecom

array of (TelecomItem)

 

telecom

gender

string

 

gender

birthDate

string

 

birthDate

deceasedBoolean

boolean

 

deceasedBoolean

address

array of (AddressItem)

 

address

 

NameItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

family

string

 

family

given

array of (string)

 

given

 

TelecomItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

system

string

 

system

value

string

 

value

rank

integer(int32)

 

rank

 

AddressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

type

string

 

type

text

string

 

text

line

array of (string)

 

line

city

string

 

city

district

string

 

district

state

string

 

state

postalCode

string

 

postalCode

period

Period

 

period

 

Period

Summary:

Description: period

 

          Properties:

Name

Type

Summary

start

string

 

start

 


 

DELETE_Patient_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

active

boolean

 

active

name

array of (NameItem)

 

name

telecom

array of (TelecomItem)

 

telecom

gender

string

 

gender

birthDate

string

 

birthDate

deceasedBoolean

boolean

 

deceasedBoolean

address

array of (AddressItem)

 

address

 

NameItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

family

string

 

family

given

array of (string)

 

given

 

TelecomItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

system

string

 

system

value

string

 

value

rank

integer(int32)

 

rank

 

AddressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

type

string

 

type

text

string

 

text

line

array of (string)

 

line

city

string

 

city

district

string

 

district

state

string

 

state

postalCode

string

 

postalCode

period

Period

 

period

 

Period

Summary:

Description: period

 

          Properties:

Name

Type

Summary

start

string

 

start

 


 

DELETE_Person_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

name

array of (NameItem)

 

name

telecom

array of (TelecomItem)

 

telecom

gender

string

 

gender

birthDate

string

 

birthDate

address

array of (AddressItem)

 

address

managingOrganization

ManagingOrganization

 

managingOrganization

active

boolean

 

active

link

array of (LinkItem)

 

link

 

NameItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

family

string

 

family

given

array of (string)

 

given

 

TelecomItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

value

string

 

value

use

string

 

use

 

AddressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

line

array of (string)

 

line

city

string

 

city

state

string

 

state

 

ManagingOrganization

Summary:

Description: managingOrganization

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

LinkItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

target

Target

 

target

assurance

string

 

assurance

 

Target

Summary:

Description: target

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Person_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

name

array of (NameItem)

 

name

telecom

array of (TelecomItem)

 

telecom

gender

string

 

gender

birthDate

string

 

birthDate

address

array of (AddressItem)

 

address

managingOrganization

ManagingOrganization

 

managingOrganization

active

boolean

 

active

link

array of (LinkItem)

 

link

 

NameItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

family

string

 

family

given

array of (string)

 

given

 

TelecomItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

value

string

 

value

use

string

 

use

 

AddressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

use

string

 

use

line

array of (string)

 

line

city

string

 

city

state

string

 

state

 

ManagingOrganization

Summary:

Description: managingOrganization

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 

LinkItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

target

Target

 

target

assurance

string

 

assurance

 

Target

Summary:

Description: target

 

          Properties:

Name

Type

Summary

reference

string

 

reference

display

string

 

display

 


 

DELETE_Practitioner_IDParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

meta

Meta

 

meta

identifier

array of (IdentifierItem)

 

identifier

active

boolean

 

active

name

array of (NameItem)

 

name

telecom

array of (TelecomItem)

 

telecom

address

array of (AddressItem)

 

address

gender

string

 

gender

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

versionId

string

 

versionId

lastUpdated

string

 

lastUpdated

 

IdentifierItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

value

string

 

value

 

NameItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

family

string

 

family

given

array of (string)

 

given

prefix

array of (string)

 

prefix

 

TelecomItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

 

system

value

string

 

value

use

string

 

use

 

AddressItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

line

array of (string)

 

line

city

string

 

city

state

string

 

state

postalCode

string

 

postalCode

country

string

 

country

 


 

DELETE_Practitioner_IDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceType

string

 

resourceType

id

string

 

id

text

Text

 

text

identifier

array of (IdentifierItem)

 

identifier

active

boolean

 

active

name

array of (NameItem)

 

name

address

array of (AddressItem)

 

address

qualification

array of (QualificationItem)

 

qualification

 

Text

Summary:

Description: text

 

          Properties: