persons

Create Person

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

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

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringPersonThis is a Person resource
identifierarray(Identifier)Identifier for a person within a particular scope.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender.
birthDatestringThe birth date for the person.
addressarray(Address)One or more addresses for the person.
photoAttachmentAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganizationReferenceThe organization that is the custodian of the person record.
activebooleanWhether this person's record is in active use.
linkarray(Person_Link)Link to a resource that concerns the same actual person.

Response

Patch Person

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

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

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*stringPersonThis is a Person resource
identifierarray(Identifier)Identifier for a person within a particular scope.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender.
birthDatestringThe birth date for the person.
addressarray(Address)One or more addresses for the person.
photoAttachmentAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganizationReferenceThe organization that is the custodian of the person record.
activebooleanWhether this person's record is in active use.
linkarray(Person_Link)Link to a resource that concerns the same actual person.

Response

Read Person

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
birthdatestring
emailstring
genderstring
identifierstring
linkstring
namestring
organizationstring
patientstring
phonestring
phoneticstring
practitionerstring
relatedpersonstring
telecomstring

Params

organizationId*string|stringid|slug

Response

Search History Person

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

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

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
birthdatestring
emailstring
genderstring
identifierstring
linkstring
namestring
organizationstring
patientstring
phonestring
phoneticstring
practitionerstring
relatedpersonstring
telecomstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringPersonThis is a Person resource
identifierarray(Identifier)Identifier for a person within a particular scope.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender.
birthDatestringThe birth date for the person.
addressarray(Address)One or more addresses for the person.
photoAttachmentAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganizationReferenceThe organization that is the custodian of the person record.
activebooleanWhether this person's record is in active use.
linkarray(Person_Link)Link to a resource that concerns the same actual person.

Response

Update Person

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

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPersonThis is a Person resource
identifierarray(Identifier)Identifier for a person within a particular scope.
namearray(HumanName)A name associated with the person.
telecomarray(ContactPoint)A contact detail for the person, e.g. a telephone number or an email address.
genderstringmale|female|other|unknownAdministrative Gender.
birthDatestringThe birth date for the person.
addressarray(Address)One or more addresses for the person.
photoAttachmentAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganizationReferenceThe organization that is the custodian of the person record.
activebooleanWhether this person's record is in active use.
linkarray(Person_Link)Link to a resource that concerns the same actual person.

Response