Create a practitioner
/Practitioner/
Creates a practitioner to be referenced by other resources. This API is not used for user provisioning.
Authorization Types
This resource supports the following authorization types:
Request
- application/fhir+json
-
authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
object-
active:
boolean
Allowed Values:
[ true ]Whether this practitioner record is in active use.
-
identifier:
array identifier
The identifier for the practitioner.
Must be a unique identifier.
Must not contain the
idorassignerfields. -
name(required):
array name
Minimum Number of Items:
1Maximum Number of Items:1The name associated with the practitioner.
Must not contain the
textfield. -
resourceType(required):
string
Allowed Values:
[ "Practitioner" ]The type of the FHIR resource.
{
"resourceType":"Practitioner",
"active":true,
"name":[
{
"family":"Williams",
"given":[
"Rory",
"James"
],
"prefix":[
"Dr."
],
"suffix":[
"M.D."
],
"period":{
"start":"2019-12-01T00:00:00.000Z"
}
}
],
"identifier":[
{
"type":{
"coding":[
{
"code":"DEA",
"system":"http://terminology.hl7.org/CodeSystem/v2-0203"
}
]
},
"system":"urn:oid:2.16.840.1.113883.4.814",
"value":"CW1234563",
"period":{
"start":"2019-12-01T00:00:00.000Z",
"end":"2029-12-01T23:59:59.000Z"
}
}
]
}arrayThe identifier for the practitioner.
Must be a unique identifier.
Must not contain the id or assigner fields.
array11The name associated with the practitioner.
Must not contain the text field.
object-
period:
object period
-
system(required):
string
Example:
urn:oid:2.16.840.1.113883.4.814 -
type:
object type
-
use:
string
Allowed Values:
[ "official" ] -
value(required):
string
Example:
CW1234563
object-
end:
string
Must include a time component with a timezone.
Example:2029-12-01T23:59:59.000Z -
start:
string
Must include a time component with a timezone.
Example:2019-12-01T00:00:00.000Z
object-
coding:
array coding
Minimum Number of Items:
1Maximum Number of Items:1
array11object-
code:
string
Example:
DEA -
system:
string
Example:
http://terminology.hl7.org/CodeSystem/v2-0203
object-
family(required):
string
Example:
Williams -
given(required):
array given
Minimum Number of Items:
1 -
period:
object period
Must not include an
enddate. -
prefix:
array prefix
Maximum Number of Items:
1 -
suffix:
array suffix
Maximum Number of Items:
1
array1-
Array of:
string
Example:
James McAfee
objectMust not include an end date.
-
start:
string
Must include a time component with a timezone.
Example:2020-12-01T00:00:00.000Z
array1-
Array of:
string
Example:
Dr.
array1-
Array of:
string
Example:
M.D.
Response
- application/fhir+json
201 Response
Created
-
ETag: string
The identifier for a specific version of a resource. This identifier is formatted as
W/"and used to specify the" If-Matchheader value on subsequent updates. -
Location: string
The URL of the created entity.
Example:
https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/7118008 -
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.
Default Response
-
Etag: string
For Update or Patch versioning controls. Related to
If-Match. When a resource performs an operation that creates or updates a record, anEtagvalue is returned as a header. This same value should be included in request headers as anIf-Matchfor 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.
object-
issue(required):
array issue
-
resourceType(required):
string
Allowed Values:
[ "OperationOutcome" ]