Jump to

• Request
• Response

Create a patient

post

/Patient

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Creates a patient from the supported HL7 US Core 6.1.0 input subset. This operation requires the registration-facility-organization extension in Patient.extension.

Request

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

Supported Media Types

• application/fhir+json
• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The supported patient input for create.

Show Source

• active: boolean
  Allowed Values: [ true ]
• address: array address
• birthDate: string (date)
• communication: array communication
  Maximum Number of Items: 1
• extension(required): array extension
  Minimum Number of Items: 1
• gender(required): string
  Allowed Values: [ "male", "female", "other", "unknown" ]
• generalPractitioner: array generalPractitioner
• identifier(required): array identifier
  Minimum Number of Items: 1
• maritalStatus: object CodeableConcept
• name(required): array name
  Minimum Number of Items: 1
• resourceType(required): string
  Allowed Values: [ "Patient" ]
• telecom: array telecom

{
    "type":"object",
    "description":"The supported patient input for create.",
    "required":[
        "resourceType",
        "identifier",
        "extension",
        "name",
        "gender"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Patient"
            ]
        },
        "active":{
            "type":"boolean",
            "enum":[
                true
            ]
        },
        "identifier":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/IdentifierForPatient"
            }
        },
        "extension":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        },
        "name":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/HumanName"
            }
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPointForPatient"
            }
        },
        "address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        },
        "gender":{
            "type":"string",
            "enum":[
                "male",
                "female",
                "other",
                "unknown"
            ]
        },
        "birthDate":{
            "type":"string",
            "format":"date"
        },
        "maritalStatus":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "communication":{
            "type":"array",
            "maxItems":1,
            "items":{
                "$ref":"#/components/schemas/CommunicationForPatient"
            }
        },
        "generalPractitioner":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForPatient"
            }
        }
    }
}

Nested Schema : address

Type: array

Show Source

• Array of: object Address

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Address"
    }
}

Nested Schema : communication

Type: array

Maximum Number of Items: 1

Show Source

• Array of: object CommunicationForPatient

{
    "type":"array",
    "maxItems":1,
    "items":{
        "$ref":"#/components/schemas/CommunicationForPatient"
    }
}

Nested Schema : extension

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : generalPractitioner

Type: array

Show Source

• Array of: object ReferenceForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForPatient"
    }
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object IdentifierForPatient

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/IdentifierForPatient"
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : name

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object HumanName

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/HumanName"
    }
}

Nested Schema : telecom

Type: array

Show Source

• Array of: object ContactPointForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPointForPatient"
    }
}

Nested Schema : Address

Type: object

Show Source

• city: string
• country: string
• district: string
• line: array line
• period: object Period
• postalCode: string
• state: string
• text: string
• type: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "line":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : line

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : CommunicationForPatient

Type: object

Show Source

• language: object CodeableConcept
• preferred: boolean

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "language":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "preferred":{
            "type":"boolean"
        }
    }
}

Nested Schema : ExtensionForPatient

Type: object

The FHIR extension, including supported US Core and Oracle patient extensions.

Show Source

• extension: array extension
• url: string
• valueBoolean: boolean
• valueCode: string
• valueCodeableConcept: object CodeableConceptForPatient
• valueCoding: object Coding
• valueDateTime: string (date-time)
• valueReference: object ReferenceForPatient
• valueString: string
• valueUrl: string

{
    "type":"object",
    "description":"The FHIR extension, including supported US Core and Oracle patient extensions.",
    "properties":{
        "url":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        },
        "valueCode":{
            "type":"string"
        },
        "valueString":{
            "type":"string"
        },
        "valueBoolean":{
            "type":"boolean"
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "valueUrl":{
            "type":"string"
        },
        "valueCoding":{
            "$ref":"#/components/schemas/Coding"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConceptForPatient"
        },
        "valueReference":{
            "$ref":"#/components/schemas/ReferenceForPatient"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : CodeableConceptForPatient

Type: object

Show Source

• coding: array coding
• extension: array extension
• id: string
• text: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : ReferenceForPatient

Type: object

Show Source

• display: string
• reference: string
• type: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Nested Schema : Extension

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierForPatient

Type: object

Show Source

• _system: object PrimitiveElementForPatient
• _value: object PrimitiveElementForPatient
• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "type":"string"
        },
        "_system":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "value":{
            "type":"string"
        },
        "_value":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : PrimitiveElementForPatient

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : HumanName

Type: object

Show Source

• family: string
• given: array given
• period: object Period
• prefix: array prefix
• suffix: array suffix
• text: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "family":{
            "type":"string"
        },
        "given":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "prefix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "suffix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : given

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : prefix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : suffix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ContactPointForPatient

Type: object

Show Source

• _system: object PrimitiveElementForPatient
• _value: object PrimitiveElementForPatient
• extension: array extension
• period: object Period
• rank: integer
  Minimum Value: 1
• system: string
  Allowed Values: [ "phone", "fax", "email", "pager", "url", "sms", "other" ]
• use: string
  Allowed Values: [ "home", "work", "temp", "old", "mobile" ]
• value: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "system":{
            "type":"string",
            "enum":[
                "phone",
                "fax",
                "email",
                "pager",
                "url",
                "sms",
                "other"
            ]
        },
        "_system":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "value":{
            "type":"string"
        },
        "_value":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "use":{
            "type":"string",
            "enum":[
                "home",
                "work",
                "temp",
                "old",
                "mobile"
            ]
        },
        "rank":{
            "type":"integer",
            "minimum":1
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Request Body - application/fhir+json ()

Root Schema : schema

Type: object

The supported patient input for create.

Show Source

• active: boolean
  Allowed Values: [ true ]
• address: array address
• birthDate: string (date)
• communication: array communication
  Maximum Number of Items: 1
• extension(required): array extension
  Minimum Number of Items: 1
• gender(required): string
  Allowed Values: [ "male", "female", "other", "unknown" ]
• generalPractitioner: array generalPractitioner
• identifier(required): array identifier
  Minimum Number of Items: 1
• maritalStatus: object CodeableConcept
• name(required): array name
  Minimum Number of Items: 1
• resourceType(required): string
  Allowed Values: [ "Patient" ]
• telecom: array telecom

{
    "type":"object",
    "description":"The supported patient input for create.",
    "required":[
        "resourceType",
        "identifier",
        "extension",
        "name",
        "gender"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Patient"
            ]
        },
        "active":{
            "type":"boolean",
            "enum":[
                true
            ]
        },
        "identifier":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/IdentifierForPatient"
            }
        },
        "extension":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        },
        "name":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/HumanName"
            }
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPointForPatient"
            }
        },
        "address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        },
        "gender":{
            "type":"string",
            "enum":[
                "male",
                "female",
                "other",
                "unknown"
            ]
        },
        "birthDate":{
            "type":"string",
            "format":"date"
        },
        "maritalStatus":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "communication":{
            "type":"array",
            "maxItems":1,
            "items":{
                "$ref":"#/components/schemas/CommunicationForPatient"
            }
        },
        "generalPractitioner":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForPatient"
            }
        }
    }
}

Nested Schema : address

Type: array

Show Source

• Array of: object Address

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Address"
    }
}

Nested Schema : communication

Type: array

Maximum Number of Items: 1

Show Source

• Array of: object CommunicationForPatient

{
    "type":"array",
    "maxItems":1,
    "items":{
        "$ref":"#/components/schemas/CommunicationForPatient"
    }
}

Nested Schema : extension

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : generalPractitioner

Type: array

Show Source

• Array of: object ReferenceForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForPatient"
    }
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object IdentifierForPatient

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/IdentifierForPatient"
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : name

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object HumanName

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/HumanName"
    }
}

Nested Schema : telecom

Type: array

Show Source

• Array of: object ContactPointForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPointForPatient"
    }
}

Nested Schema : Address

Type: object

Show Source

• city: string
• country: string
• district: string
• line: array line
• period: object Period
• postalCode: string
• state: string
• text: string
• type: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "line":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : line

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : CommunicationForPatient

Type: object

Show Source

• language: object CodeableConcept
• preferred: boolean

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "language":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "preferred":{
            "type":"boolean"
        }
    }
}

Nested Schema : ExtensionForPatient

Type: object

The FHIR extension, including supported US Core and Oracle patient extensions.

Show Source

• extension: array extension
• url: string
• valueBoolean: boolean
• valueCode: string
• valueCodeableConcept: object CodeableConceptForPatient
• valueCoding: object Coding
• valueDateTime: string (date-time)
• valueReference: object ReferenceForPatient
• valueString: string
• valueUrl: string

{
    "type":"object",
    "description":"The FHIR extension, including supported US Core and Oracle patient extensions.",
    "properties":{
        "url":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        },
        "valueCode":{
            "type":"string"
        },
        "valueString":{
            "type":"string"
        },
        "valueBoolean":{
            "type":"boolean"
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "valueUrl":{
            "type":"string"
        },
        "valueCoding":{
            "$ref":"#/components/schemas/Coding"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConceptForPatient"
        },
        "valueReference":{
            "$ref":"#/components/schemas/ReferenceForPatient"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : CodeableConceptForPatient

Type: object

Show Source

• coding: array coding
• extension: array extension
• id: string
• text: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : ReferenceForPatient

Type: object

Show Source

• display: string
• reference: string
• type: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Nested Schema : Extension

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierForPatient

Type: object

Show Source

• _system: object PrimitiveElementForPatient
• _value: object PrimitiveElementForPatient
• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "type":"string"
        },
        "_system":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "value":{
            "type":"string"
        },
        "_value":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : PrimitiveElementForPatient

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : HumanName

Type: object

Show Source

• family: string
• given: array given
• period: object Period
• prefix: array prefix
• suffix: array suffix
• text: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "family":{
            "type":"string"
        },
        "given":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "prefix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "suffix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : given

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : prefix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : suffix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ContactPointForPatient

Type: object

Show Source

• _system: object PrimitiveElementForPatient
• _value: object PrimitiveElementForPatient
• extension: array extension
• period: object Period
• rank: integer
  Minimum Value: 1
• system: string
  Allowed Values: [ "phone", "fax", "email", "pager", "url", "sms", "other" ]
• use: string
  Allowed Values: [ "home", "work", "temp", "old", "mobile" ]
• value: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "system":{
            "type":"string",
            "enum":[
                "phone",
                "fax",
                "email",
                "pager",
                "url",
                "sms",
                "other"
            ]
        },
        "_system":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "value":{
            "type":"string"
        },
        "_value":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "use":{
            "type":"string",
            "enum":[
                "home",
                "work",
                "temp",
                "old",
                "mobile"
            ]
        },
        "rank":{
            "type":"integer",
            "minimum":1
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Back to Top

Response

Supported Media Types

• application/fhir+json

201 Response

The patient is created; response body is empty.

Headers

• Location:
  The URL of the created patient.

400 Response

The registration-facility input is invalid.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

422 Response

The patient or terminology validation failed.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

500 Response

The patient creation failed.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top