Oracle Cloud Infrastructure Documentation

Create Specimen

Create a FHIR R4 Specimen resource.

Endpoint

POST /api/fhir/r4/Specimen

Base URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4

Example URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Specimen

Headers

{"Accept":"application/fhir+json","Authorization":"Bearer [REDACTED]","Content-Type":"application/fhir+json"}

Parameters

ParameterInRequiredTypeDescription
No parameters

Authorization

The supported authorization model uses OAuth 2.0 scopes issued by OCI Identity Domains. Send the access token as a bearer token. Resource-server definitions and issued access-token claims use canonical system/... scopes. Client grants and token requests use the corresponding ddfssystem/... form. For examples, see Reference: Authentication and Scopes.

Context Scope form
Resource-server definition system/Specimen.c
Client grant/token request ddfssystem/Specimen.c
Issued token's scope claim system/Specimen.c

Example Request

{"resourceType":"Specimen","identifier":[{"system":"https://example.com/fhir/identifier/specimen","value":"documentation-example"}],"status":"available","type":{"coding":[{"system":"http://snomed.info/sct","code":"119297000","display":"Blood specimen"}]},"subject":{"reference":"Patient/00000000-0000-4000-8000-000000000010"},"receivedTime":"2020-01-01T00:00:00Z","meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"}]}}

Example Response

{
  "resourceType": "Specimen",
  "id": "00000000-0000-4000-8000-000000000016",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2020-01-01T00:00:00Z",
    "profile": [],
    "security": [],
    "tag": [
      {
        "system": "https://example.com/fhir/tag",
        "code": "documentation-example",
        "display": "Documentation example"
      }
    ]
  },
  "identifier": [
    {
      "system": "https://example.com/fhir/identifier/specimen",
      "value": "documentation-example"
    }
  ],
  "status": "available",
  "type": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "119297000",
        "display": "Blood specimen"
      }
    ]
  },
  "subject": {
    "reference": "Patient/00000000-0000-4000-8000-000000000010"
  },
  "receivedTime": "2020-01-01T00:00:00Z",
  "parent": [],
  "request": [],
  "processing": [],
  "container": [],
  "condition": [],
  "note": []
}

Behavior

Creates a Specimen resource.

cURL Example

curl.exe `
  -sS `
  --connect-timeout 10 `
  --max-time 90 `
  -X POST `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Specimen `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]' `
  -H 'Content-Type: application/fhir+json' `
  --data '{"resourceType":"Specimen","identifier":[{"system":"https://example.com/fhir/identifier/specimen","value":"documentation-example"}],"status":"available","type":{"coding":[{"system":"http://snomed.info/sct","code":"119297000","display":"Blood specimen"}]},"subject":{"reference":"Patient/00000000-0000-4000-8000-000000000010"},"receivedTime":"2020-01-01T00:00:00Z","meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"}]}}'

Status Codes

CodeStatus
201 Created Specimen representation.

FHIR Definition

Canonical: https://hl7.org/fhir/R4/specimen.html

Related Operations