practitioners
Create Practitioner
post
/organizations/{organizationId}/fhir/3/Practitioner
A person who is directly or indirectly involved in the provisioning of healthcare.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Practitioner | This is a Practitioner resource |
| identifier | array(Identifier) | An identifier that applies to this person in this role. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| name | array(HumanName) | The name(s) associated with the practitioner. | |
| telecom | array(ContactPoint) | A contact detail for the practitioner, e.g. a telephone number or an email address. | |
| address | array(Address) | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. | |
| gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
| birthDate | string | The date of birth for the practitioner. | |
| photo | array(Attachment) | Image of the person. | |
| qualification | array(Practitioner_Qualification) | Qualifications obtained by training and certification. | |
| communication | array(CodeableConcept) | A language the practitioner is able to use in patient communication. |
Response
keyboard_arrow_down
Patch Practitioner
patch
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}
A person who is directly or indirectly involved in the provisioning of healthcare.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Practitioner | This is a Practitioner resource |
| identifier | array(Identifier) | An identifier that applies to this person in this role. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| name | array(HumanName) | The name(s) associated with the practitioner. | |
| telecom | array(ContactPoint) | A contact detail for the practitioner, e.g. a telephone number or an email address. | |
| address | array(Address) | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. | |
| gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
| birthDate | string | The date of birth for the practitioner. | |
| photo | array(Attachment) | Image of the person. | |
| qualification | array(Practitioner_Qualification) | Qualifications obtained by training and certification. | |
| communication | array(CodeableConcept) | A language the practitioner is able to use in patient communication. |
Response
keyboard_arrow_down
Read Practitioner
get
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Practitioner
get
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Practitioner
get
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Practitioner
delete
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Practitioner
get
/organizations/{organizationId}/fhir/3/Practitioner
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| address | string | ||
| address-city | string | ||
| address-country | string | ||
| address-postalcode | string | ||
| address-state | string | ||
| address-use | string | ||
| communication | string | ||
| string | |||
| family | string | ||
| gender | string | ||
| given | string | ||
| identifier | string | ||
| name | string | ||
| phone | string | ||
| phonetic | string | ||
| telecom | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Practitioner
get
/organizations/{organizationId}/fhir/3/Practitioner/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Practitioner
post
/organizations/{organizationId}/fhir/3/Practitioner/_search
A person who is directly or indirectly involved in the provisioning of healthcare.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| address | string | ||
| address-city | string | ||
| address-country | string | ||
| address-postalcode | string | ||
| address-state | string | ||
| address-use | string | ||
| communication | string | ||
| string | |||
| family | string | ||
| gender | string | ||
| given | string | ||
| identifier | string | ||
| name | string | ||
| phone | string | ||
| phonetic | string | ||
| telecom | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Practitioner | This is a Practitioner resource |
| identifier | array(Identifier) | An identifier that applies to this person in this role. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| name | array(HumanName) | The name(s) associated with the practitioner. | |
| telecom | array(ContactPoint) | A contact detail for the practitioner, e.g. a telephone number or an email address. | |
| address | array(Address) | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. | |
| gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
| birthDate | string | The date of birth for the practitioner. | |
| photo | array(Attachment) | Image of the person. | |
| qualification | array(Practitioner_Qualification) | Qualifications obtained by training and certification. | |
| communication | array(CodeableConcept) | A language the practitioner is able to use in patient communication. |
Response
keyboard_arrow_down
Update Practitioner
put
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}
A person who is directly or indirectly involved in the provisioning of healthcare.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Practitioner | This is a Practitioner resource |
| identifier | array(Identifier) | An identifier that applies to this person in this role. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| name | array(HumanName) | The name(s) associated with the practitioner. | |
| telecom | array(ContactPoint) | A contact detail for the practitioner, e.g. a telephone number or an email address. | |
| address | array(Address) | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. | |
| gender | string | male|female|other|unknown | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
| birthDate | string | The date of birth for the practitioner. | |
| photo | array(Attachment) | Image of the person. | |
| qualification | array(Practitioner_Qualification) | Qualifications obtained by training and certification. | |
| communication | array(CodeableConcept) | A language the practitioner is able to use in patient communication. |
Response
keyboard_arrow_down