Practitioner

Overview
Terminology Bindings
Extensions
- Custom Extensions
Search
Retrieve by id
Create

Overview

The Practitioner Resource provides information about a person formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include but are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers.

Not all practitioners have access to the EHR but can be referenced by other resources to indicate they are in some way involved in a patient’s care.

The following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:
- US Core Practitioner Profile

The following fields are returned if valued:

Terminology Bindings

Practitioner.identifier.type

Description

The type used to determine which identifier to use for a specific purpose.

Details: Identifier Type Codes
System: http://hl7.org/fhir/identifier-type

Details: v2 Identifier Type
System: http://terminology.hl7.org/CodeSystem/v2-0203

Practitioner.qualification.code

Description

Coded representation of the qualification.

Details: Qualification codes
System: http://terminology.hl7.org/CodeSystem/v2-0360|2.7

Extensions

Is Physician

Custom Extensions

All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}

ID	Value[x] Type	Description
`is-physician`	`Boolean`	Indication of whether the provider is a physician or not.

Search

Search for Practitioners that meet supplied query parameters:

GET /Practitioner?:parameters

Authorization Types

Provider | Patient | System

Parameters

Name	Required?	Type	Description
`_id`	This or any other required search parameter	`token`	The logical resource id associated with the resource.
`identifier`	This or any other required search parameter	`token`	A practitioner identifier/alias. Example: `http://hl7.org/fhir/sid/us-npi\|4326587548`
`family`	This or any other required search parameter	`string`	The start of the family name of the practitioner. Example: `Smith`
`given`	This and `family`, or any other required search parameter	`string`	The start of the given name of the practitioner. Example: `John`
`name`	This or any other required search parameter	`string`	The start of the first, middle or last name of the practitioner. Example: `John` or `Smith`
`active`	This or any other required search parameter	`token`	true or false. Example: `active=true`
`_count`	No	`number`	Number of results per page.

Notes:

When provided, the identifier query parameter must include both a system and a code.
The given parameter may only be provided if family parameter is provided.
The name parameter must have at least 2 characters
When provided, the active query parameter must not include system. It accepts only true or false code.

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "7ec264d2-c7c7-49b2-8478-22351c82db73",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936",
      "resource": {
        "resourceType": "Practitioner",
        "id": "109413936",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2019-03-07T20:40:34.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Lombardi, Falco Shine</p><p><b>Identifiers</b>: DOCUPIN: F88788, DOCDEA: 887887887, SPI: 16611661, NPI: 6656656, PRSNLPRIMID: 12332122</p><p><b>Gender</b>: Male</p><p><b>Status</b>: Active</p></div>"
        },
        "extension": [
          {
            "valueBoolean": true,
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
          }
        ],
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "PRN",
                  "display": "Provider number"
                }
              ],
              "text": "DOCUPIN"
            },
            "_system": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                  "valueCode": "unknown"
                }
              ]
            },
            "value": "F88788",
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "DEA",
                  "display": "Drug Enforcement Administration registration number"
                }
              ],
              "text": "DOCDEA"
            },
            "system": "urn:oid:2.16.840.1.113883.4.814",
            "value": "887887887",
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "PRN",
                  "display": "Provider number"
                }
              ],
              "text": "SureScripts Prescriber Index"
            },
            "system": "urn:oid:2.16.840.1.113883.3.2054",
            "value": "16611661",
            "period": {
              "start": "2019-04-12T18:24:23.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NPI",
                  "display": "National provider identifier"
                }
              ],
              "text": "National Provider Identifier"
            },
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "6656656",
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "text": "Personnel Primary Identifier"
            },
            "system": "urn:oid:1.2.243.58",
            "value": "12332122",
            "period": {
              "start": "2019-04-12T18:24:23.000Z"
            }
          }
        ],
        "active": true,
        "name": [
          {
            "use": "usual",
            "text": "Lombardi, Falco Shine",
            "family": "Lombardi",
            "given": [
              "Falco",
              "Shine"
            ],
            "prefix": [
              "Dr."
            ],
            "suffix": [
              "M.D."
            ],
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "7861231234",
            "use": "work"
          },
          {
            "system": "email",
            "value": "falco.lombardi@sfox.com",
            "use": "work"
          }
        ],
        "address": [
          {
            "use": "work",
            "text": "111 Corneria Dr.\\nTallahassee, FL 32304\\nUSA",
            "line": [
              "111 Corneria Dr."
            ],
            "city": "Tallahassee",
            "district": "Leon",
            "state": "FL",
            "postalCode": "32304",
            "country": "USA"
          }
        ],
        "gender": "male",
        "qualification": [
          {
            "code": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
                  "code": "677091",
                  "display": "MD",
                  "userSelected": true
                }
              ],
              "text": "MD"
            },
            "period": {
              "start": "2014-07-09T06:00:00.000Z"
            }
          },
          {
            "code": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
                  "code": "677079",
                  "display": "PhD",
                  "userSelected": true
                }
              ],
              "text": "PhD"
            },
            "period": {
              "start": "2014-07-09T06:00:00.000Z"
            }
          }
        ]
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?active=true

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "7ec264d2-c7c7-49b2-8478-22351c82db73",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?active=true&_count=100"
    },
    {
      "relation": "next",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?active=true&_count=100&-offset=100"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936",
      "resource": {
        "resourceType": "Practitioner",
        "id": "109413936",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2019-03-07T20:40:34.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Lombardi, Falco Shine</p><p><b>Identifiers</b>: DOCUPIN: F88788, DOCDEA: 887887887, SPI: 16611661, NPI: 6656656, PRSNLPRIMID: 12332122</p><p><b>Gender</b>: Male</p><p><b>Status</b>: Active</p></div>"
        },
        "extension": [
          {
            "valueBoolean": true,
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
          }
        ],
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "PRN",
                  "display": "Provider number"
                }
              ],
              "text": "DOCUPIN"
            },
            "_system": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                  "valueCode": "unknown"
                }
              ]
            },
            "value": "F88788",
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "DEA",
                  "display": "Drug Enforcement Administration registration number"
                }
              ],
              "text": "DOCDEA"
            },
            "system": "urn:oid:2.16.840.1.113883.4.814",
            "value": "887887887",
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "PRN",
                  "display": "Provider number"
                }
              ],
              "text": "SureScripts Prescriber Index"
            },
            "system": "urn:oid:2.16.840.1.113883.3.2054",
            "value": "16611661",
            "period": {
              "start": "2019-04-12T18:24:23.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NPI",
                  "display": "National provider identifier"
                }
              ],
              "text": "National Provider Identifier"
            },
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "6656656",
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "text": "Personnel Primary Identifier"
            },
            "system": "urn:oid:1.2.243.58",
            "value": "12332122",
            "period": {
              "start": "2019-04-12T18:24:23.000Z"
            }
          }
        ],
        "active": true,
        "name": [
          {
            "use": "usual",
            "text": "Lombardi, Falco Shine",
            "family": "Lombardi",
            "given": [
              "Falco",
              "Shine"
            ],
            "prefix": [
              "Dr."
            ],
            "suffix": [
              "M.D."
            ],
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "7861231234",
            "use": "work"
          },
          {
            "system": "email",
            "value": "falco.lombardi@sfox.com",
            "use": "work"
          }
        ],
        "address": [
          {
            "use": "work",
            "text": "111 Corneria Dr.\\nTallahassee, FL 32304\\nUSA",
            "line": [
              "111 Corneria Dr."
            ],
            "city": "Tallahassee",
            "district": "Leon",
            "state": "FL",
            "postalCode": "32304",
            "country": "USA"
          }
        ],
        "gender": "male",
        "qualification": [
          {
            "code": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
                  "code": "677091",
                  "display": "MD",
                  "userSelected": true
                }
              ],
              "text": "MD"
            },
            "period": {
              "start": "2014-07-09T06:00:00.000Z"
            }
          },
          {
            "code": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
                  "code": "677079",
                  "display": "PhD",
                  "userSelected": true
                }
              ],
              "text": "PhD"
            },
            "period": {
              "start": "2014-07-09T06:00:00.000Z"
            }
          }
        ]
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Patient Authorization Request

GET https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "13230afb-0bbd-45a6-a7c9-9c6d286a2f4c",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner?_id=109413936"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936",
      "resource": {
        "resourceType": "Practitioner",
        "id": "109413936",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2019-03-07T20:40:34.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Lombardi, Falco Shine</p><p><b>Identifiers</b>: SPI: 16611661, NPI: 6656656</p><p><b>Gender</b>: Male</p><p><b>Status</b>: Active</p></div>"
        },
        "extension": [
          {
            "valueBoolean": true,
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
          }
        ],
        "identifier": [
          {
            "use": "usual",
            "type": {
              "text": "SureScripts Prescriber Index"
            },
            "system": "urn:oid:2.16.840.1.113883.3.2054",
            "value": "16611661",
            "period": {
              "start": "2019-04-12T18:24:23.000Z"
            }
          },
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NPI",
                  "display": "National provider identifier"
                }
              ],
              "text": "National Provider Identifier"
            },
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "6656656",
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          }
        ],
        "active": true,
        "name": [
          {
            "use": "usual",
            "text": "Lombardi, Falco Shine",
            "family": "Lombardi",
            "given": [
              "Falco",
              "Shine"
            ],
            "prefix": [
              "Dr."
            ],
            "suffix": [
              "M.D."
            ],
            "period": {
              "start": "2019-03-07T20:40:35.000Z"
            }
          }
        ],
        "telecom": [
          {
            "value": "falco.lombardi@sfox.com"
          }
        ],
        "gender": "male"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by id

List an individual Practitioner by its id:

GET /Practitioner/:id

Authorization Types

Provider | Patient | System

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/4122622

Response

Status: 200 OK

{
  "resourceType": "Practitioner",
  "id": "109413936",
  "meta": {
    "versionId": "0",
    "lastUpdated": "2019-03-07T20:40:34.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Lombardi, Falco Shine</p><p><b>Identifiers</b>: DOCUPIN: F88788, DOCDEA: 887887887, SPI: 16611661, NPI: 6656656, PRSNLPRIMID: 12332122</p><p><b>Gender</b>: Male</p><p><b>Status</b>: Active</p></div>"
  },
  "extension": [
    {
      "valueBoolean": true,
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "PRN",
            "display": "Provider number"
          }
        ],
        "text": "DOCUPIN"
      },
      "_system": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "unknown"
          }
        ]
      },
      "value": "F88788",
      "period": {
        "start": "2019-03-07T20:40:35.000Z"
      }
    },
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "DEA",
            "display": "Drug Enforcement Administration registration number"
          }
        ],
        "text": "DOCDEA"
      },
      "system": "urn:oid:2.16.840.1.113883.4.814",
      "value": "887887887",
      "period": {
        "start": "2019-03-07T20:40:35.000Z"
      }
    },
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "PRN",
            "display": "Provider number"
          }
        ],
        "text": "SureScripts Prescriber Index"
      },
      "system": "urn:oid:2.16.840.1.113883.3.2054",
      "value": "16611661",
      "period": {
        "start": "2019-04-12T18:24:23.000Z"
      }
    },
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "NPI",
            "display": "National provider identifier"
          }
        ],
        "text": "National Provider Identifier"
      },
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "6656656",
      "period": {
        "start": "2019-03-07T20:40:35.000Z"
      }
    },
    {
      "use": "usual",
      "type": {
        "text": "Personnel Primary Identifier"
      },
      "system": "urn:oid:1.2.243.58",
      "value": "12332122",
      "period": {
        "start": "2019-04-12T18:24:23.000Z"
      }
    }
  ],
  "active": true,
  "name": [
    {
      "use": "usual",
      "text": "Lombardi, Falco Shine",
      "family": "Lombardi",
      "given": [
        "Falco",
        "Shine"
      ],
      "prefix": [
        "Dr."
      ],
      "suffix": [
        "M.D."
      ],
      "period": {
        "start": "2019-03-07T20:40:35.000Z"
      }
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "7861231234",
      "use": "work"
    },
    {
      "system": "email",
      "value": "falco.lombardi@sfox.com",
      "use": "work"
    }
  ],
  "address": [
    {
      "use": "work",
      "text": "111 Corneria Dr.\\nTallahassee, FL 32304\\nUSA",
      "line": [
        "111 Corneria Dr."
      ],
      "city": "Tallahassee",
      "district": "Leon",
      "state": "FL",
      "postalCode": "32304",
      "country": "USA"
    }
  ],
  "gender": "male",
  "qualification": [
    {
      "code": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
            "code": "677091",
            "display": "MD",
            "userSelected": true
          }
        ],
        "text": "MD"
      },
      "period": {
        "start": "2014-07-09T06:00:00.000Z"
      }
    },
    {
      "code": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/29600",
            "code": "677079",
            "display": "PhD",
            "userSelected": true
          }
        ],
        "text": "PhD"
      },
      "period": {
        "start": "2014-07-09T06:00:00.000Z"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Patient Authorization Request

GET https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/109413936

Response

Status: 200 OK

{
  "resourceType": "Practitioner",
  "id": "109413936",
  "meta": {
    "versionId": "0",
    "lastUpdated": "2019-03-07T20:40:34.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Practitioner</b></p><p><b>Name</b>: Lombardi, Falco Shine</p><p><b>Identifiers</b>: SPI: 16611661, NPI: 6656656</p><p><b>Gender</b>: Male</p><p><b>Status</b>: Active</p></div>"
  },
  "extension": [
    {
      "valueBoolean": true,
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/is-physician"
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "text": "SureScripts Prescriber Index"
      },
      "system": "urn:oid:2.16.840.1.113883.3.2054",
      "value": "16611661",
      "period": {
        "start": "2019-04-12T18:24:23.000Z"
      }
    },
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "NPI",
            "display": "National provider identifier"
          }
        ],
        "text": "National Provider Identifier"
      },
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "6656656",
      "period": {
        "start": "2019-03-07T20:40:35.000Z"
      }
    }
  ],
  "active": true,
  "name": [
    {
      "use": "usual",
      "text": "Lombardi, Falco Shine",
      "family": "Lombardi",
      "given": [
        "Falco",
        "Shine"
      ],
      "prefix": [
        "Dr."
      ],
      "suffix": [
        "M.D."
      ],
      "period": {
        "start": "2019-03-07T20:40:35.000Z"
      }
    }
  ],
  "telecom": [
    {
      "value": "falco.lombardi@sfox.com"
    }
  ],
  "gender": "male"
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Create

Create an individual Practitioner that can be referenced by other resources. This API is not used for user provisioning.

POST /Practitioner

Authorization Types

Provider | System

Headers

Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json

Body Fields

Name	Required	Type
`resourceType`	Yes	`string`
Description The type of the FHIR resource. Example { "resourceType": "Practitioner" } Notes resourceType must be Practitioner. top of section
`name`	Yes	`HumanName`
Description The name associated with the practitioner. Example { "name": [ { "family": "Williams", "given": [ "Rory", "James McAfee" ], "prefix": [ "Dr." ], "suffix": [ "M.D." ], "period": { "start": "2019-12-01T00:00:00.000Z" } } ] } Notes Exactly one name must be provided. The provided name must meet the following conditions: Must include both `given` and `family`. Up to two values may be present in the `given` names array. If more than two given names are required, the second value in the array accepts whitespace-delimited strings. Only one `prefix` and one `suffix` may be provided. Cannot contain the `text` field. Must not have an `end` date on `period`. When specifying a `period`, the fields must include a time component with a timezone. top of section
`identifier`	No	`List` `of` `Identifier`
Description The identifier(s) for the practitioner. Example { "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" } } ] } Notes If provided, each identifier must meet the following conditions: Must be a unique identifier. Must not contain the `id` or `assigner` fields. If set, `use` must have a value of 'official'. If set, `type` must contain exactly one `coding` field. Must contain the `system` and `value` fields. When specifying a `period`, the fields must include a time component with a timezone. top of section
`active`	No	`boolean`
Description Whether this practitioner record is in active use. Example { "active": true } Notes If set, value must be true. top of section

Example

Request

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

Body

{
  "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"
      }
    }
  ]
}

Response

Status: 201 Created

Cache-Control: no-cache
Content-Length: 0
Content-Type: application/fhir+json
Date: Mon, 09 Dec 2019 18:57:39 GMT
Etag: W/"0"
Last-Modified: Mon, 09 Dec 2019 18:57:39 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Practitioner/7118008
Vary: Origin
X-Request-Id: 9d3aecfa-c846-4ce2-825a-7ba2fce4813f

Errors

The common errors and OperationOutcomes may be returned.

Millennium

Practitioner

Overview

Terminology Bindings

Extensions

Custom Extensions

Search

Authorization Types

Parameters

Headers

Example

Request

Response

Request

Response

Patient Authorization Request

Response

Errors

Retrieve by id

Authorization Types

Headers

Example

Request

Response

Patient Authorization Request

Response

Errors

Create

Authorization Types

Headers

Body Fields

Example

Request

Body

Response

Errors

R4 Overview

Foundation

Base

Clinical

Financial

Specialized

Bulk Data