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*	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	Person	This is a Person resource
identifier	array(Identifier)		Identifier for a person within a particular scope.
name	array(HumanName)		A name associated with the person.
telecom	array(ContactPoint)		A contact detail for the person, e.g. a telephone number or an email address.
gender	string	male\|female\|other\|unknown	Administrative Gender.
birthDate	string		The birth date for the person.
address	array(Address)		One or more addresses for the person.
photo	Attachment		An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganization	Reference		The organization that is the custodian of the person record.
active	boolean		Whether this person's record is in active use.
link	array(Person_Link)		Link to a resource that concerns the same actual person.

Response

201 400 401 404

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*	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	Person	This is a Person resource
identifier	array(Identifier)		Identifier for a person within a particular scope.
name	array(HumanName)		A name associated with the person.
telecom	array(ContactPoint)		A contact detail for the person, e.g. a telephone number or an email address.
gender	string	male\|female\|other\|unknown	Administrative Gender.
birthDate	string		The birth date for the person.
address	array(Address)		One or more addresses for the person.
photo	Attachment		An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganization	Reference		The organization that is the custodian of the person record.
active	boolean		Whether this person's record is in active use.
link	array(Person_Link)		Link to a resource that concerns the same actual person.

Response

200 201 400 401 404 409

Read Person

get

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

200 401 404

Read History Person

get

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

200 401 404

Read Version Person

get

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

200 400 401 404

Remove Person

delete

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

200 204 400 401 404 409

Search Get Person

get

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

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
address	string
address-city	string
address-country	string
address-postalcode	string
address-state	string
address-use	string
birthdate	string
email	string
gender	string
identifier	string
link	string
name	string
organization	string
patient	string
phone	string
phonetic	string
practitioner	string
relatedperson	string
telecom	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Person

get

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

200 401 404

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*	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
address	string
address-city	string
address-country	string
address-postalcode	string
address-state	string
address-use	string
birthdate	string
email	string
gender	string
identifier	string
link	string
name	string
organization	string
patient	string
phone	string
phonetic	string
practitioner	string
relatedperson	string
telecom	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Person	This is a Person resource
identifier	array(Identifier)		Identifier for a person within a particular scope.
name	array(HumanName)		A name associated with the person.
telecom	array(ContactPoint)		A contact detail for the person, e.g. a telephone number or an email address.
gender	string	male\|female\|other\|unknown	Administrative Gender.
birthDate	string		The birth date for the person.
address	array(Address)		One or more addresses for the person.
photo	Attachment		An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganization	Reference		The organization that is the custodian of the person record.
active	boolean		Whether this person's record is in active use.
link	array(Person_Link)		Link to a resource that concerns the same actual person.

Response

200 401 404

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*	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	Person	This is a Person resource
identifier	array(Identifier)		Identifier for a person within a particular scope.
name	array(HumanName)		A name associated with the person.
telecom	array(ContactPoint)		A contact detail for the person, e.g. a telephone number or an email address.
gender	string	male\|female\|other\|unknown	Administrative Gender.
birthDate	string		The birth date for the person.
address	array(Address)		One or more addresses for the person.
photo	Attachment		An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
managingOrganization	Reference		The organization that is the custodian of the person record.
active	boolean		Whether this person's record is in active use.
link	array(Person_Link)		Link to a resource that concerns the same actual person.

Response

200 201 400 401 404 409