patients

Create Patient

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

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

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Patient resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
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.
gendermale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatedateThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)An address for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (boolean) 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.
communicationarray(Patient_Communication)A language 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/4/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*This is a Patient resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
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.
gendermale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatedateThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)An address for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (boolean) 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.
communicationarray(Patient_Communication)A language 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/4/Patient/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Patient

get
/organizations/{organizationId}/fhir/4/Patient/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Patient/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Patient

delete
/organizations/{organizationId}/fhir/4/Patient/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Patient

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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
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/4/Patient/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
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*This is a Patient resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
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.
gendermale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatedateThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)An address for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (boolean) 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.
communicationarray(Patient_Communication)A language 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/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Patient resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)An identifier for this patient.
activebooleanWhether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
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.
gendermale|female|other|unknownAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
birthDatedateThe date of birth for the individual.
deceasedBooleanbooleanIndicates if the individual is deceased or not.
deceasedDateTimestringIndicates if the individual is deceased or not.
addressarray(Address)An address for the individual.
maritalStatusCodeableConceptThis field contains a patient's most recent marital (civil) status.
multipleBirthBooleanbooleanIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
multipleBirthIntegernumberIndicates whether the patient is part of a multiple (boolean) 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.
communicationarray(Patient_Communication)A language 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