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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringPractitionerThis is a Practitioner resource
identifierarray(Identifier)An identifier that applies to this person in this role.
activebooleanWhether this practitioner's record is in active use.
namearray(HumanName)The name(s) associated with the practitioner.
telecomarray(ContactPoint)A contact detail for the practitioner, e.g. a telephone number or an email address.
addressarray(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.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the practitioner.
photoarray(Attachment)Image of the person.
qualificationarray(Practitioner_Qualification)Qualifications obtained by training and certification.
communicationarray(CodeableConcept)A language the practitioner is able to use in patient communication.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPractitionerThis is a Practitioner resource
identifierarray(Identifier)An identifier that applies to this person in this role.
activebooleanWhether this practitioner's record is in active use.
namearray(HumanName)The name(s) associated with the practitioner.
telecomarray(ContactPoint)A contact detail for the practitioner, e.g. a telephone number or an email address.
addressarray(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.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the practitioner.
photoarray(Attachment)Image of the person.
qualificationarray(Practitioner_Qualification)Qualifications obtained by training and certification.
communicationarray(CodeableConcept)A language the practitioner is able to use in patient communication.

Response

Read Practitioner

get
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Practitioner

get
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Practitioner

get
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Practitioner

delete
/organizations/{organizationId}/fhir/3/Practitioner/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Practitioner

get
/organizations/{organizationId}/fhir/3/Practitioner

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
communicationstring
emailstring
familystring
genderstring
givenstring
identifierstring
namestring
phonestring
phoneticstring
telecomstring

Params

organizationId*string|stringid|slug

Response

Search History Practitioner

get
/organizations/{organizationId}/fhir/3/Practitioner/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
communicationstring
emailstring
familystring
genderstring
givenstring
identifierstring
namestring
phonestring
phoneticstring
telecomstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringPractitionerThis is a Practitioner resource
identifierarray(Identifier)An identifier that applies to this person in this role.
activebooleanWhether this practitioner's record is in active use.
namearray(HumanName)The name(s) associated with the practitioner.
telecomarray(ContactPoint)A contact detail for the practitioner, e.g. a telephone number or an email address.
addressarray(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.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the practitioner.
photoarray(Attachment)Image of the person.
qualificationarray(Practitioner_Qualification)Qualifications obtained by training and certification.
communicationarray(CodeableConcept)A language the practitioner is able to use in patient communication.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPractitionerThis is a Practitioner resource
identifierarray(Identifier)An identifier that applies to this person in this role.
activebooleanWhether this practitioner's record is in active use.
namearray(HumanName)The name(s) associated with the practitioner.
telecomarray(ContactPoint)A contact detail for the practitioner, e.g. a telephone number or an email address.
addressarray(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.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the practitioner.
photoarray(Attachment)Image of the person.
qualificationarray(Practitioner_Qualification)Qualifications obtained by training and certification.
communicationarray(CodeableConcept)A language the practitioner is able to use in patient communication.

Response