Create Organization
Create a FHIR R4 Organization resource.
Endpoint
POST /api/fhir/r4/Organization
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/Organization
Headers
{"Accept":"application/fhir+json","Authorization":"Bearer [REDACTED]","Content-Type":"application/fhir+json"}
Parameters
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
| 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/Organization.c |
| Client grant/token request | ddfssystem/Organization.c |
Issued token's scope claim |
system/Organization.c |
Example Request
{"resourceType":"Organization","identifier":[{"system":"https://example.com/fhir/identifier/organization","value":"documentation-example"}],"active":true,"name":"Example organization","meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"}]},"address":[{"city":"Austin","state":"TX","postalCode":"78701"}]}
Example Response
{
"resourceType": "Organization",
"id": "00000000-0000-4000-8000-000000000009",
"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/organization",
"value": "documentation-example"
}
],
"active": true,
"type": [],
"name": "Example organization",
"alias": [],
"telecom": [],
"address": [
{
"line": [],
"city": "Austin",
"state": "TX",
"postalCode": "78701"
}
],
"contact": [],
"endpoint": []
}
Behavior
Creates a Organization 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/Organization `
-H 'Accept: application/fhir+json' `
-H 'Authorization: Bearer [REDACTED]' `
-H 'Content-Type: application/fhir+json' `
--data '{"resourceType":"Organization","identifier":[{"system":"https://example.com/fhir/identifier/organization","value":"documentation-example"}],"active":true,"name":"Example organization","meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"}]},"address":[{"city":"Austin","state":"TX","postalCode":"78701"}]}'
Status Codes
| Code | Status |
|---|---|
| 201 | Created Organization representation. |
FHIR Definition
Canonical: https://hl7.org/fhir/R4/organization.html