patients

Create Patient

post
/organizations/{organizationId}/fhir/3/Patient

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

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringPatientThis is a Patient resource
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use.
namearray(HumanName)A name associated with the individual.
telecomarray(ContactPoint)A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)Addresses for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
photoarray(Attachment)Image of the patient.
contactarray(Patient_Contact)A contact party (e.g. guardian, partner, friend) for the patient.
animalPatient_AnimalThis patient is known to be an animal.
communicationarray(Patient_Communication)Languages which may be used to communicate with the patient about his or her health.
generalPractitionerarray(Reference)Patient's nominated care provider.
managingOrganizationReferenceOrganization that is the custodian of the patient record.
linkarray(Patient_Link)Link to another patient resource that concerns the same actual patient.

Response

Patch Patient

patch
/organizations/{organizationId}/fhir/3/Patient/{resourceId}

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

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*stringPatientThis is a Patient resource
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use.
namearray(HumanName)A name associated with the individual.
telecomarray(ContactPoint)A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)Addresses for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
photoarray(Attachment)Image of the patient.
contactarray(Patient_Contact)A contact party (e.g. guardian, partner, friend) for the patient.
animalPatient_AnimalThis patient is known to be an animal.
communicationarray(Patient_Communication)Languages which may be used to communicate with the patient about his or her health.
generalPractitionerarray(Reference)Patient's nominated care provider.
managingOrganizationReferenceOrganization that is the custodian of the patient record.
linkarray(Patient_Link)Link to another patient resource that concerns the same actual patient.

Response

Read Patient

get
/organizations/{organizationId}/fhir/3/Patient/{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 Patient

get
/organizations/{organizationId}/fhir/3/Patient/{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 Patient

get
/organizations/{organizationId}/fhir/3/Patient/{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 Patient

delete
/organizations/{organizationId}/fhir/3/Patient/{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 Patient

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

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
animal-breedstring
animal-speciesstring
birthdatestring
death-datestring
deceasedstring
emailstring
familystring
genderstring
general-practitionerstring
givenstring
identifierstring
languagestring
linkstring
namestring
organizationstring
phonestring
phoneticstring
telecomstring

Params

organizationId*string|stringid|slug

Response

Search History Patient

get
/organizations/{organizationId}/fhir/3/Patient/_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 Patient

post
/organizations/{organizationId}/fhir/3/Patient/_search

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

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
animal-breedstring
animal-speciesstring
birthdatestring
death-datestring
deceasedstring
emailstring
familystring
genderstring
general-practitionerstring
givenstring
identifierstring
languagestring
linkstring
namestring
organizationstring
phonestring
phoneticstring
telecomstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringPatientThis is a Patient resource
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use.
namearray(HumanName)A name associated with the individual.
telecomarray(ContactPoint)A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)Addresses for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
photoarray(Attachment)Image of the patient.
contactarray(Patient_Contact)A contact party (e.g. guardian, partner, friend) for the patient.
animalPatient_AnimalThis patient is known to be an animal.
communicationarray(Patient_Communication)Languages which may be used to communicate with the patient about his or her health.
generalPractitionerarray(Reference)Patient's nominated care provider.
managingOrganizationReferenceOrganization that is the custodian of the patient record.
linkarray(Patient_Link)Link to another patient resource that concerns the same actual patient.

Response

Update Patient

put
/organizations/{organizationId}/fhir/3/Patient/{resourceId}

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPatientThis is a Patient resource
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use.
namearray(HumanName)A name associated with the individual.
telecomarray(ContactPoint)A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
genderstringmale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatestringThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)Addresses for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
photoarray(Attachment)Image of the patient.
contactarray(Patient_Contact)A contact party (e.g. guardian, partner, friend) for the patient.
animalPatient_AnimalThis patient is known to be an animal.
communicationarray(Patient_Communication)Languages which may be used to communicate with the patient about his or her health.
generalPractitionerarray(Reference)Patient's nominated care provider.
managingOrganizationReferenceOrganization that is the custodian of the patient record.
linkarray(Patient_Link)Link to another patient resource that concerns the same actual patient.

Response