basics
Create Basic
post
/organizations/{organizationId}/fhir/3/Basic
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
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 | Basic | This is a Basic resource |
| identifier | array(Identifier) | Identifier assigned to the resource for business purposes, outside the context of FHIR. | |
| code* | CodeableConcept | Identifies the 'type' of resource - equivalent to the resource name for other resources. | |
| subject | Reference | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. | |
| created | string | Identifies when the resource was first created. | |
| author | Reference | Indicates who was responsible for creating the resource instance. |
Response
keyboard_arrow_down
Patch Basic
patch
/organizations/{organizationId}/fhir/3/Basic/{resourceId}
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
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 | Basic | This is a Basic resource |
| identifier | array(Identifier) | Identifier assigned to the resource for business purposes, outside the context of FHIR. | |
| code* | CodeableConcept | Identifies the 'type' of resource - equivalent to the resource name for other resources. | |
| subject | Reference | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. | |
| created | string | Identifies when the resource was first created. | |
| author | Reference | Indicates who was responsible for creating the resource instance. |
Response
keyboard_arrow_down
Read Basic
get
/organizations/{organizationId}/fhir/3/Basic/{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 Basic
get
/organizations/{organizationId}/fhir/3/Basic/{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 Basic
get
/organizations/{organizationId}/fhir/3/Basic/{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 Basic
delete
/organizations/{organizationId}/fhir/3/Basic/{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 Basic
get
/organizations/{organizationId}/fhir/3/Basic
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 | ||
| author | string | ||
| code | string | ||
| created | string | ||
| identifier | string | ||
| patient | string | ||
| subject | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Basic
get
/organizations/{organizationId}/fhir/3/Basic/_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 Basic
post
/organizations/{organizationId}/fhir/3/Basic/_search
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
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 | ||
| author | string | ||
| code | string | ||
| created | string | ||
| identifier | string | ||
| patient | string | ||
| subject | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Basic | This is a Basic resource |
| identifier | array(Identifier) | Identifier assigned to the resource for business purposes, outside the context of FHIR. | |
| code* | CodeableConcept | Identifies the 'type' of resource - equivalent to the resource name for other resources. | |
| subject | Reference | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. | |
| created | string | Identifies when the resource was first created. | |
| author | Reference | Indicates who was responsible for creating the resource instance. |
Response
keyboard_arrow_down
Update Basic
put
/organizations/{organizationId}/fhir/3/Basic/{resourceId}
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
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 | Basic | This is a Basic resource |
| identifier | array(Identifier) | Identifier assigned to the resource for business purposes, outside the context of FHIR. | |
| code* | CodeableConcept | Identifies the 'type' of resource - equivalent to the resource name for other resources. | |
| subject | Reference | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. | |
| created | string | Identifies when the resource was first created. | |
| author | Reference | Indicates who was responsible for creating the resource instance. |
Response
keyboard_arrow_down