FHIR R4 APIs for Oracle Health Millennium Platform

Create an organization

post

/Organization

Creates a new organization.

Note: Only the body fields mentioned below are supported. Unsupported fields are ignored or can result in errors.

Authorization Types

This operation supports the following authorization types:

Request

Supported Media Types

application/fhir+json

Header Parameters

Authorization(required): string

Contains the credentials to authenticate a consumer to the service. The credentials should be the OAuth2 Bearer Token.
accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.

The body of the create operation

Root Schema : OrganizationCreate

Type: object

A summary representation of the create (POST) operation for an organization.

Show Source

active: boolean
Whether the organization's record is still in active use.
Note: If set, value must be true.
Example:
```
{
  "active": true
}
```

identifier: string

The identifier for the organization.
Note: If set, the provided identifier must meet the following conditions:

Must contain the system, value, and type fields.
Must contain only an NPI, OID, or TAXID system.

Example:

{
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "FHIR-NPI-10191",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "NPI"
          }
        ]
      }
    }
  ]
}

name(required): string
The name used for the organization.
Note: At least one name must be provided and should be unique.
Example:
```
{
  "name": "example-organization"
}
```
resourceType(required): string

Allowed Values: [ "Organization" ]

The type of the FHIR resource.

type: array type

The organization type.
Example:

{
  "type": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/organization-type",
          "code": "govt"
        }
      ]
    }
  ]
}

{
    "description":"A summary representation of the create (POST) operation for an organization.",
    "type":"object",
    "required":[
        "resourceType",
        "name"
    ],
    "properties":{
        "resourceType":{
            "description":"The type of the FHIR resource.\n",
            "type":"string",
            "enum":[
                "Organization"
            ]
        },
        "identifier":{
            "description":"The identifier for the organization.<br>\n\n<b>Note:</b> If set, the provided identifier must meet the following conditions:\n    <ul>\n      <li>Must contain the <code>system</code>, <code>value</code>, and <code>type</code> fields.</li>\n      <li> Must contain only an NPI, OID, or TAXID system. </li>\n    </ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"identifier\": [\n    {\n      \"system\": \"http://hl7.org/fhir/sid/us-npi\",\n      \"value\": \"FHIR-NPI-10191\",\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0203\",\n            \"code\": \"NPI\"\n          }\n        ]\n      }\n    }\n  ]\n}</code></pre>\n",
            "type":"string"
        },
        "active":{
            "description":"Whether the organization's record is still in active use.<br>\n\n<b>Note:</b> If set, value must be <code>true</code>.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"active\": true\n}</code></pre>\n",
            "type":"boolean"
        },
        "name":{
            "description":"The name used for the organization.<br>\n\n<b>Note:</b> At least one name must be provided and should be unique.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"name\": \"example-organization\"\n}</code></pre>\n",
            "type":"string"
        },
        "type":{
            "description":"The organization type.<br>\n<b>Example:</b>\n\n<pre><code>{\n  \"type\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/organization-type\",\n          \"code\": \"govt\"\n        }\n      ]\n    }\n  ]\n}</code></pre>\n",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "text":{
                        "type":"string"
                    },
                    "coding":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "system":{
                                    "type":"string"
                                },
                                "code":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : type

Type: array

The organization type.
Example:

{
  "type": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/organization-type",
          "code": "govt"
        }
      ]
    }
  ]
}

Show Source

Array of: object items

{
    "description":"The organization type.<br>\n<b>Example:</b>\n\n<pre><code>{\n  \"type\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/organization-type\",\n          \"code\": \"govt\"\n        }\n      ]\n    }\n  ]\n}</code></pre>\n",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "text":{
                "type":"string"
            },
            "coding":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "system":{
                            "type":"string"
                        },
                        "code":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

coding: array coding
text: string

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : coding

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "system":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

code: string
system: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/fhir+json

Default Response

Example Request:

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Organization

Example Request Body:

{
    'resourceType': 'Organization',
    'identifier': [
      {
        'system': 'http://hl7.org/fhir/sid/us-npi',
        'value': 'FHIR-NPI-10191',
        'type': {
          'coding': [
            {
              'system': 'http://terminology.hl7.org/CodeSystem/v2-0203',
              'code': 'NPI'
            }
          ]
        }
      }
    ],
    'active': true,
    'name': 'sandbox-fhir-org1',
    'type': [
      {
        'coding': [
          {
            'system': 'http://terminology.hl7.org/CodeSystem/organization-type',
            'code': 'govt'
          }
        ]
      }
    ]
  }

Example Response:

  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Wed, 14 Aug 2019 17:23:14 GMT
  Etag: W/"6767735"
  Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Organization/6767735
  Last-Modified: Wed, 14 Aug 2019 17:23:14 GMT
  Vary: Origin
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111
  X-Request-Id: 11111111-1111-1111-1111-111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

Etag: string

For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.