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* | 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 | BodySite | This is a BodySite resource |
| identifier | array(Identifier) | Identifier for this instance of the anatomical location. | |
| active | boolean | Whether this body site is in active use. | |
| code | CodeableConcept | Named anatomical location - ideally coded where possible. | |
| qualifier | array(CodeableConcept) | Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. | |
| description | string | A summary, charactarization or explanation of the anatomic location. | |
| image | array(Attachment) | Image or images used to identify a location. | |
| patient* | Reference | The person to which the body site belongs. |
Response
keyboard_arrow_down
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* | 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 | BodySite | This is a BodySite resource |
| identifier | array(Identifier) | Identifier for this instance of the anatomical location. | |
| active | boolean | Whether this body site is in active use. | |
| code | CodeableConcept | Named anatomical location - ideally coded where possible. | |
| qualifier | array(CodeableConcept) | Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. | |
| description | string | A summary, charactarization or explanation of the anatomic location. | |
| image | array(Attachment) | Image or images used to identify a location. | |
| patient* | Reference | The person to which the body site belongs. |
Response
keyboard_arrow_down
Read Body Site
get
/organizations/{organizationId}/fhir/3/BodySite/{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
keyboard_arrow_down
Read History Body Site
get
/organizations/{organizationId}/fhir/3/BodySite/{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
keyboard_arrow_down
Read Version Body Site
get
/organizations/{organizationId}/fhir/3/BodySite/{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
keyboard_arrow_down
Remove Body Site
delete
/organizations/{organizationId}/fhir/3/BodySite/{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
keyboard_arrow_down
Search Get Body Site
get
/organizations/{organizationId}/fhir/3/BodySite
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 | ||
| code | string | ||
| focalAccess | string | ||
| identifier | string | ||
| patient | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Body Site
get
/organizations/{organizationId}/fhir/3/BodySite/_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
keyboard_arrow_down
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* | 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 | ||
| code | string | ||
| focalAccess | string | ||
| identifier | string | ||
| patient | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | BodySite | This is a BodySite resource |
| identifier | array(Identifier) | Identifier for this instance of the anatomical location. | |
| active | boolean | Whether this body site is in active use. | |
| code | CodeableConcept | Named anatomical location - ideally coded where possible. | |
| qualifier | array(CodeableConcept) | Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. | |
| description | string | A summary, charactarization or explanation of the anatomic location. | |
| image | array(Attachment) | Image or images used to identify a location. | |
| patient* | Reference | The person to which the body site belongs. |
Response
keyboard_arrow_down
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* | 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 | BodySite | This is a BodySite resource |
| identifier | array(Identifier) | Identifier for this instance of the anatomical location. | |
| active | boolean | Whether this body site is in active use. | |
| code | CodeableConcept | Named anatomical location - ideally coded where possible. | |
| qualifier | array(CodeableConcept) | Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. | |
| description | string | A summary, charactarization or explanation of the anatomic location. | |
| image | array(Attachment) | Image or images used to identify a location. | |
| patient* | Reference | The person to which the body site belongs. |
Response
keyboard_arrow_down