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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringBasicThis is a Basic resource
identifierarray(Identifier)Identifier assigned to the resource for business purposes, outside the context of FHIR.
code*CodeableConceptIdentifies the 'type' of resource - equivalent to the resource name for other resources.
subjectReferenceIdentifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
createdstringIdentifies when the resource was first created.
authorReferenceIndicates who was responsible for creating the resource instance.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringBasicThis is a Basic resource
identifierarray(Identifier)Identifier assigned to the resource for business purposes, outside the context of FHIR.
code*CodeableConceptIdentifies the 'type' of resource - equivalent to the resource name for other resources.
subjectReferenceIdentifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
createdstringIdentifies when the resource was first created.
authorReferenceIndicates who was responsible for creating the resource instance.

Response

Read Basic

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
authorstring
codestring
createdstring
identifierstring
patientstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Basic

get
/organizations/{organizationId}/fhir/3/Basic/_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 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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
codestring
createdstring
identifierstring
patientstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringBasicThis is a Basic resource
identifierarray(Identifier)Identifier assigned to the resource for business purposes, outside the context of FHIR.
code*CodeableConceptIdentifies the 'type' of resource - equivalent to the resource name for other resources.
subjectReferenceIdentifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
createdstringIdentifies when the resource was first created.
authorReferenceIndicates who was responsible for creating the resource instance.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringBasicThis is a Basic resource
identifierarray(Identifier)Identifier assigned to the resource for business purposes, outside the context of FHIR.
code*CodeableConceptIdentifies the 'type' of resource - equivalent to the resource name for other resources.
subjectReferenceIdentifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
createdstringIdentifies when the resource was first created.
authorReferenceIndicates who was responsible for creating the resource instance.

Response