body sites

Create Body Site

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

Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringBodySiteThis is a BodySite resource
identifierarray(Identifier)Identifier for this instance of the anatomical location.
activebooleanWhether this body site is in active use.
codeCodeableConceptNamed anatomical location - ideally coded where possible.
qualifierarray(CodeableConcept)Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
descriptionstringA summary, charactarization or explanation of the anatomic location.
imagearray(Attachment)Image or images used to identify a location.
patient*ReferenceThe person to which the body site belongs.

Response

Patch Body Site

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

Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

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*stringBodySiteThis is a BodySite resource
identifierarray(Identifier)Identifier for this instance of the anatomical location.
activebooleanWhether this body site is in active use.
codeCodeableConceptNamed anatomical location - ideally coded where possible.
qualifierarray(CodeableConcept)Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
descriptionstringA summary, charactarization or explanation of the anatomic location.
imagearray(Attachment)Image or images used to identify a location.
patient*ReferenceThe person to which the body site belongs.

Response

Read Body Site

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
codestring
focalAccessstring
identifierstring
patientstring

Params

organizationId*string|stringid|slug

Response

Search History Body Site

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

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

Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Request

Headers

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

Query params

_idstring
_languagestring
codestring
focalAccessstring
identifierstring
patientstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringBodySiteThis is a BodySite resource
identifierarray(Identifier)Identifier for this instance of the anatomical location.
activebooleanWhether this body site is in active use.
codeCodeableConceptNamed anatomical location - ideally coded where possible.
qualifierarray(CodeableConcept)Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
descriptionstringA summary, charactarization or explanation of the anatomic location.
imagearray(Attachment)Image or images used to identify a location.
patient*ReferenceThe person to which the body site belongs.

Response

Update Body Site

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

Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringBodySiteThis is a BodySite resource
identifierarray(Identifier)Identifier for this instance of the anatomical location.
activebooleanWhether this body site is in active use.
codeCodeableConceptNamed anatomical location - ideally coded where possible.
qualifierarray(CodeableConcept)Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
descriptionstringA summary, charactarization or explanation of the anatomic location.
imagearray(Attachment)Image or images used to identify a location.
patient*ReferenceThe person to which the body site belongs.

Response