Root Schema : PatientCreateBody
Type: object
Show Source
-
active:
boolean
Allowed Values: [
true
]
Whether this patient record is in active use.
-
address:
array address
Addresses for the individual.
-
birthDate:
string
The date of birth for the individual.
Example: 1989-09-17
-
careProvider:
array careProvider
Patient's nominated care provider.
-
communication:
array communication
Minimum Number of Items: 1
Maximum Number of Items: 1
Language which may be used to communicate with the patient about their health.
-
extension:
array extension
Minimum Number of Items: 1
Maximum Number of Items: 1
The Argonaut Birth Sex Extension is supported.
-
gender:
string
Allowed Values: [
"male",
"female",
"other",
"unknown"
]
The gender that the patient is considered to have for administration and record keeping purposes.
-
identifier(required):
array identifier
Minimum Number of Items: 1
The identifiers for the patient.
At least one identifier must be provided. The provided identifier must be a reference to the Organization in which the patient is being enrolled.
Subsequent identifiers may be provided, but have the following constraints:
- Must not contain the
assigner
and use
fields.
- Must contain the
type
, system
, and value
fields.
Example:
{
"identifier": [
{
"assigner": {
"reference": "Organization/685844"
}
},
{
"type": {
"coding": [
{
"code": "MR",
"system": "http://hl7.org/fhir/v2/0203"
}
]
},
"system": "urn:oid:1.1.1.1.1.1",
"value": "MR-1234",
"period": {
"start": "2016-01-02T00:00:00-05:00",
"end": "2020-01-02T00:00:00-05:00"
}
}
]
}
-
maritalStatus:
object maritalStatus
The patient's most recent marital (civil) status.
-
name(required):
array name
Minimum Number of Items: 1
The names associated with the individual.
At least one name must be provided.
- It must have a
use
of official.
- If a
period
is provided, it must not have an end
date.
- It must include both a
given
and a family
name.
All provided names:
- Must not contain the
text
field.
- Must contain either a
given
or family
name.
Example:
{
"name": [
{
"use": "official",
"family": [
"Wolf"
],
"given": [
"Big",
"Bad"
],
"period": {
"start": "2010-05-17T14:54:31.000Z"
}
},
{
"use": "usual",
"given": [
"Bigby"
],
"period": {
"start": "2012-05-22T15:45:50.000Z"
}
}
]
}
-
resourceType(required):
string
Allowed Values: [
"Patient"
]
The type of the FHIR resource.
-
telecom:
array telecom
A contact detail (such as a telephone number or an email address) by which the patient may be contacted.
{
"type":"object",
"required":[
"resourceType",
"identifier",
"name"
],
"properties":{
"resourceType":{
"description":"<p>The type of the FHIR resource.</p>\n",
"type":"string",
"enum":[
"Patient"
]
},
"identifier":{
"description":"<p>The identifiers for the patient.</p>\n<p>At least one identifier must be provided. The provided identifier must be a reference to the Organization in which the patient is being enrolled.</p>\n<p>Subsequent identifiers may be provided, but have the following constraints:\n <ul>\n <li>Must not contain the <code>assigner</code> and <code>use</code> fields.</li>\n <li>Must contain the <code>type</code>, <code>system</code>, and <code>value</code> fields.</li>\n </ul>\n</p>\n<p><b>Example:</b>\n <pre><code>{\n \"identifier\": [\n {\n \"assigner\": {\n \"reference\": \"Organization/685844\"\n }\n },\n {\n \"type\": {\n \"coding\": [\n {\n \"code\": \"MR\",\n \"system\": \"http://hl7.org/fhir/v2/0203\"\n }\n ]\n },\n \"system\": \"urn:oid:1.1.1.1.1.1\",\n \"value\": \"MR-1234\",\n \"period\": {\n \"start\": \"2016-01-02T00:00:00-05:00\",\n \"end\": \"2020-01-02T00:00:00-05:00\"\n }\n }\n ]\n}\n </code></pre>\n</p>\n",
"type":"array",
"minItems":"1",
"items":{
"type":"object",
"properties":{
"assigner":{
"type":"string",
"description":"<p>May only be provided on the first identifier object. Contains a reference to the organization in which the patient is being enrolled.</p>\n",
"example":"Organization/619848"
},
"type":{
"type":"object",
"properties":{
"coding":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"example":"MR"
},
"system":{
"type":"string",
"example":"http://hl7.org/fhir/v2/0203"
}
}
}
}
}
},
"system":{
"type":"string",
"example":"urn:oid:1.1.1.1.1.1"
},
"value":{
"type":"string",
"description":"<p>Must be a unique value.</p>",
"example":"CW1234563"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2019-12-01T00:00:00.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2029-12-01T23:59:59.000Z"
}
}
}
}
}
},
"name":{
"description":"<p>The names associated with the individual.</p>\n<p>At least one name must be provided.\n <ul>\n <li>It must have a <code>use</code> of official.</li>\n <li>If a <code>period</code> is provided, it must not have an <code>end</code> date.</li>\n <li>It must include both a <code>given</code> and a <code>family</code> name.</li>\n </ul>\n</p>\n<p>All provided names:\n <ul>\n <li>Must not contain the <code>text</code> field.</li>\n <li>Must contain either a <code>given</code> or <code>family</code> name.</li>\n </ul>\n</p>\n<p><b>Example:</b>\n <pre><code>{\n \"name\": [\n {\n \"use\": \"official\",\n \"family\": [\n \"Wolf\"\n ],\n \"given\": [\n \"Big\",\n \"Bad\"\n ],\n \"period\": {\n \"start\": \"2010-05-17T14:54:31.000Z\"\n }\n },\n {\n \"use\": \"usual\",\n \"given\": [\n \"Bigby\"\n ],\n \"period\": {\n \"start\": \"2012-05-22T15:45:50.000Z\"\n }\n }\n ]\n}\n </code></pre>\n</p>\n",
"type":"array",
"minItems":"1",
"items":{
"description":"<p>Must not include the <code>text</code> field.</p>\n",
"type":"object",
"required":[
"use"
],
"properties":{
"use":{
"type":"string",
"enum":[
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
]
},
"family":{
"description":"<p>If more than one family name is required, they must be provided as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Williams"
}
},
"given":{
"description":"<p>If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"2",
"items":{
"type":"string",
"maxLength":"100",
"example":"James McAfee"
}
},
"prefix":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Dr."
}
},
"suffix":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"M.D."
}
},
"period":{
"type":"object",
"description":"<p>Must not include an <code>end</code> date.</p>",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2020-12-01T00:00:00.000Z"
}
}
}
}
}
},
"active":{
"description":"<p>Whether this patient record is in active use.</p>\n",
"type":"boolean",
"enum":[
true
]
},
"telecom":{
"description":"<p>A contact detail (such as a telephone number or an email address) by which the patient may be contacted.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"system",
"use",
"value"
],
"properties":{
"system":{
"type":"string",
"enum":[
"phone",
"fax",
"email",
"pager",
"other"
]
},
"value":{
"type":"string",
"maxLength":"100"
},
"use":{
"type":"string",
"enum":[
"home",
"work",
"temp",
"old",
"mobile"
]
},
"rank":{
"type":"integer"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2028-05-17T15:33:18.000Z"
}
}
}
}
}
},
"gender":{
"description":"<p>The gender that the patient is considered to have for administration and record keeping purposes.</p>\n",
"type":"string",
"enum":[
"male",
"female",
"other",
"unknown"
]
},
"birthDate":{
"description":"<p>The date of birth for the individual.</p>\n",
"type":"string",
"example":"1989-09-17"
},
"address":{
"description":"<p>Addresses for the individual.</p>\n",
"type":"array",
"items":{
"type":"object",
"description":"<p>Must not contain the <code>text</code> field.</p>\n",
"required":[
"use"
],
"properties":{
"use":{
"type":"string",
"enum":[
"home",
"work",
"temp",
"old"
]
},
"type":{
"type":"string",
"enum":[
"postal",
"physical",
"both"
]
},
"line":{
"type":"array",
"items":{
"type":"string",
"maxLength":"100",
"example":"1212 Faircastle Drive"
},
"example":[
"1212 Faircastle Drive",
"Apartment 406"
]
},
"city":{
"type":"string",
"example":"KC"
},
"district":{
"type":"string",
"example":"Jackson"
},
"state":{
"type":"string",
"example":"KS"
},
"postalCode":{
"type":"string",
"example":"64199"
},
"country":{
"type":"string",
"example":"United States of America"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"example":"2032-05-17T15:33:18.000Z"
}
}
}
}
}
},
"maritalStatus":{
"description":"<p>The patient's most recent marital (civil) status.</p>\n",
"type":"object",
"properties":{
"text":{
"type":"string",
"example":"Single"
},
"coding":{
"type":"array",
"items":{
"description":"<p>See the Marital Status Codes for valid system-code pairs.</p>\n",
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"http://hl7.org/fhir/marital-status",
"http://hl7.org/fhir/v3/MaritalStatus",
"http://hl7.org/fhir/v3/NullFlavor"
]
},
"code":{
"type":"string",
"enum":[
"U",
"A",
"D",
"I",
"L",
"M",
"P",
"S",
"T",
"W",
"UNK"
]
}
}
}
}
}
},
"communication":{
"description":"<p>Language which may be used to communicate with the patient about their health.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"required":[
"language"
],
"properties":{
"language":{
"type":"object",
"properties":{
"coding":{
"type":"array",
"items":{
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"urn:ietf:bcp:47"
]
},
"code":{
"description":"<p>Must use ISO-639-1 alpha 2 code in lower case.</p>\n",
"type":"string",
"example":"en"
},
"display":{
"type":"string",
"example":"English"
}
}
}
},
"text":{
"type":"string"
}
}
},
"preferred":{
"type":"boolean"
}
}
}
},
"careProvider":{
"description":"<p>Patient's nominated care provider.</p>\n",
"type":"array",
"items":{
"description":"<p>Must be a reference to a Practitioner.</p>",
"type":"object",
"properties":{
"reference":{
"type":"string",
"example":"Practitioner/4646007"
}
}
}
},
"extension":{
"description":"<p>The Argonaut Birth Sex Extension is supported.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"http://hl7.org/fhir/v3/AdministrativeGender",
"http://hl7.org/fhir/v3/NullFlavor"
]
},
"valueCode":{
"type":"string",
"enum":[
"F",
"M",
"UNK"
]
}
}
}
}
},
"example":{
"resourceType":"Patient",
"identifier":[
{
"assigner":{
"reference":"Organization/685844"
}
}
],
"active":true,
"name":[
{
"use":"official",
"family":[
"Wolf"
],
"given":[
"Person",
"Name"
],
"period":{
"start":"2010-05-17T14:54:31.000Z"
}
},
{
"use":"usual",
"given":[
"Bigby"
],
"period":{
"start":"2012-05-22T15:45:50.000Z"
}
}
],
"telecom":[
{
"system":"phone",
"value":"8168229121",
"use":"home",
"period":{
"start":"2012-05-17T15:33:18.000Z"
}
}
],
"gender":"male",
"birthDate":"1990-09-15",
"address":[
{
"use":"home",
"line":[
"121212 Metcalf Drive",
"Apartment 403"
],
"city":"Kansas City",
"district":"Jackson",
"state":"KS",
"postalCode":"64199",
"country":"United States of America",
"period":{
"start":"2012-05-17T15:33:18.000Z"
}
}
],
"maritalStatus":{
"coding":[
{
"system":"http://hl7.org/fhir/v3/NullFlavor",
"code":"UNK",
"display":"Unknown"
}
],
"text":"Unknown"
},
"communication":[
{
"language":{
"coding":[
{
"system":"urn:ietf:bcp:47",
"code":"en",
"display":"English"
}
],
"text":"English"
},
"preferred":true
}
],
"careProvider":[
{
"reference":"Practitioner/4122622"
}
]
}
}
Example:
{
"resourceType":"Patient",
"identifier":[
{
"assigner":{
"reference":"Organization/685844"
}
}
],
"active":true,
"name":[
{
"use":"official",
"family":[
"Wolf"
],
"given":[
"Person",
"Name"
],
"period":{
"start":"2010-05-17T14:54:31.000Z"
}
},
{
"use":"usual",
"given":[
"Bigby"
],
"period":{
"start":"2012-05-22T15:45:50.000Z"
}
}
],
"telecom":[
{
"system":"phone",
"value":"8168229121",
"use":"home",
"period":{
"start":"2012-05-17T15:33:18.000Z"
}
}
],
"gender":"male",
"birthDate":"1990-09-15",
"address":[
{
"use":"home",
"line":[
"121212 Metcalf Drive",
"Apartment 403"
],
"city":"Kansas City",
"district":"Jackson",
"state":"KS",
"postalCode":"64199",
"country":"United States of America",
"period":{
"start":"2012-05-17T15:33:18.000Z"
}
}
],
"maritalStatus":{
"coding":[
{
"system":"http://hl7.org/fhir/v3/NullFlavor",
"code":"UNK",
"display":"Unknown"
}
],
"text":"Unknown"
},
"communication":[
{
"language":{
"coding":[
{
"system":"urn:ietf:bcp:47",
"code":"en",
"display":"English"
}
],
"text":"English"
},
"preferred":true
}
],
"careProvider":[
{
"reference":"Practitioner/4122622"
}
]
}
Nested Schema : address
Type: array
Addresses for the individual.
Show Source
{
"description":"<p>Addresses for the individual.</p>\n",
"type":"array",
"items":{
"type":"object",
"description":"<p>Must not contain the <code>text</code> field.</p>\n",
"required":[
"use"
],
"properties":{
"use":{
"type":"string",
"enum":[
"home",
"work",
"temp",
"old"
]
},
"type":{
"type":"string",
"enum":[
"postal",
"physical",
"both"
]
},
"line":{
"type":"array",
"items":{
"type":"string",
"maxLength":"100",
"example":"1212 Faircastle Drive"
},
"example":[
"1212 Faircastle Drive",
"Apartment 406"
]
},
"city":{
"type":"string",
"example":"KC"
},
"district":{
"type":"string",
"example":"Jackson"
},
"state":{
"type":"string",
"example":"KS"
},
"postalCode":{
"type":"string",
"example":"64199"
},
"country":{
"type":"string",
"example":"United States of America"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"example":"2032-05-17T15:33:18.000Z"
}
}
}
}
}
}
Nested Schema : careProvider
Type: array
Patient's nominated care provider.
Show Source
{
"description":"<p>Patient's nominated care provider.</p>\n",
"type":"array",
"items":{
"description":"<p>Must be a reference to a Practitioner.</p>",
"type":"object",
"properties":{
"reference":{
"type":"string",
"example":"Practitioner/4646007"
}
}
}
}
Nested Schema : communication
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Language which may be used to communicate with the patient about their health.
Show Source
{
"description":"<p>Language which may be used to communicate with the patient about their health.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"required":[
"language"
],
"properties":{
"language":{
"type":"object",
"properties":{
"coding":{
"type":"array",
"items":{
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"urn:ietf:bcp:47"
]
},
"code":{
"description":"<p>Must use ISO-639-1 alpha 2 code in lower case.</p>\n",
"type":"string",
"example":"en"
},
"display":{
"type":"string",
"example":"English"
}
}
}
},
"text":{
"type":"string"
}
}
},
"preferred":{
"type":"boolean"
}
}
}
}
Nested Schema : extension
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
The Argonaut Birth Sex Extension is supported.
Show Source
{
"description":"<p>The Argonaut Birth Sex Extension is supported.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"http://hl7.org/fhir/v3/AdministrativeGender",
"http://hl7.org/fhir/v3/NullFlavor"
]
},
"valueCode":{
"type":"string",
"enum":[
"F",
"M",
"UNK"
]
}
}
}
}
Nested Schema : identifier
Type: array
Minimum Number of Items: 1
The identifiers for the patient.
At least one identifier must be provided. The provided identifier must be a reference to the Organization in which the patient is being enrolled.
Subsequent identifiers may be provided, but have the following constraints:
- Must not contain the
assigner
and use
fields.
- Must contain the
type
, system
, and value
fields.
Example:
{
"identifier": [
{
"assigner": {
"reference": "Organization/685844"
}
},
{
"type": {
"coding": [
{
"code": "MR",
"system": "http://hl7.org/fhir/v2/0203"
}
]
},
"system": "urn:oid:1.1.1.1.1.1",
"value": "MR-1234",
"period": {
"start": "2016-01-02T00:00:00-05:00",
"end": "2020-01-02T00:00:00-05:00"
}
}
]
}
Show Source
{
"description":"<p>The identifiers for the patient.</p>\n<p>At least one identifier must be provided. The provided identifier must be a reference to the Organization in which the patient is being enrolled.</p>\n<p>Subsequent identifiers may be provided, but have the following constraints:\n <ul>\n <li>Must not contain the <code>assigner</code> and <code>use</code> fields.</li>\n <li>Must contain the <code>type</code>, <code>system</code>, and <code>value</code> fields.</li>\n </ul>\n</p>\n<p><b>Example:</b>\n <pre><code>{\n \"identifier\": [\n {\n \"assigner\": {\n \"reference\": \"Organization/685844\"\n }\n },\n {\n \"type\": {\n \"coding\": [\n {\n \"code\": \"MR\",\n \"system\": \"http://hl7.org/fhir/v2/0203\"\n }\n ]\n },\n \"system\": \"urn:oid:1.1.1.1.1.1\",\n \"value\": \"MR-1234\",\n \"period\": {\n \"start\": \"2016-01-02T00:00:00-05:00\",\n \"end\": \"2020-01-02T00:00:00-05:00\"\n }\n }\n ]\n}\n </code></pre>\n</p>\n",
"type":"array",
"minItems":"1",
"items":{
"type":"object",
"properties":{
"assigner":{
"type":"string",
"description":"<p>May only be provided on the first identifier object. Contains a reference to the organization in which the patient is being enrolled.</p>\n",
"example":"Organization/619848"
},
"type":{
"type":"object",
"properties":{
"coding":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"example":"MR"
},
"system":{
"type":"string",
"example":"http://hl7.org/fhir/v2/0203"
}
}
}
}
}
},
"system":{
"type":"string",
"example":"urn:oid:1.1.1.1.1.1"
},
"value":{
"type":"string",
"description":"<p>Must be a unique value.</p>",
"example":"CW1234563"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2019-12-01T00:00:00.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2029-12-01T23:59:59.000Z"
}
}
}
}
}
}
Nested Schema : maritalStatus
Type: object
The patient's most recent marital (civil) status.
Show Source
{
"description":"<p>The patient's most recent marital (civil) status.</p>\n",
"type":"object",
"properties":{
"text":{
"type":"string",
"example":"Single"
},
"coding":{
"type":"array",
"items":{
"description":"<p>See the Marital Status Codes for valid system-code pairs.</p>\n",
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"http://hl7.org/fhir/marital-status",
"http://hl7.org/fhir/v3/MaritalStatus",
"http://hl7.org/fhir/v3/NullFlavor"
]
},
"code":{
"type":"string",
"enum":[
"U",
"A",
"D",
"I",
"L",
"M",
"P",
"S",
"T",
"W",
"UNK"
]
}
}
}
}
}
}
Nested Schema : name
Type: array
Minimum Number of Items: 1
The names associated with the individual.
At least one name must be provided.
- It must have a
use
of official.
- If a
period
is provided, it must not have an end
date.
- It must include both a
given
and a family
name.
All provided names:
- Must not contain the
text
field.
- Must contain either a
given
or family
name.
Example:
{
"name": [
{
"use": "official",
"family": [
"Wolf"
],
"given": [
"Big",
"Bad"
],
"period": {
"start": "2010-05-17T14:54:31.000Z"
}
},
{
"use": "usual",
"given": [
"Bigby"
],
"period": {
"start": "2012-05-22T15:45:50.000Z"
}
}
]
}
Show Source
{
"description":"<p>The names associated with the individual.</p>\n<p>At least one name must be provided.\n <ul>\n <li>It must have a <code>use</code> of official.</li>\n <li>If a <code>period</code> is provided, it must not have an <code>end</code> date.</li>\n <li>It must include both a <code>given</code> and a <code>family</code> name.</li>\n </ul>\n</p>\n<p>All provided names:\n <ul>\n <li>Must not contain the <code>text</code> field.</li>\n <li>Must contain either a <code>given</code> or <code>family</code> name.</li>\n </ul>\n</p>\n<p><b>Example:</b>\n <pre><code>{\n \"name\": [\n {\n \"use\": \"official\",\n \"family\": [\n \"Wolf\"\n ],\n \"given\": [\n \"Big\",\n \"Bad\"\n ],\n \"period\": {\n \"start\": \"2010-05-17T14:54:31.000Z\"\n }\n },\n {\n \"use\": \"usual\",\n \"given\": [\n \"Bigby\"\n ],\n \"period\": {\n \"start\": \"2012-05-22T15:45:50.000Z\"\n }\n }\n ]\n}\n </code></pre>\n</p>\n",
"type":"array",
"minItems":"1",
"items":{
"description":"<p>Must not include the <code>text</code> field.</p>\n",
"type":"object",
"required":[
"use"
],
"properties":{
"use":{
"type":"string",
"enum":[
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
]
},
"family":{
"description":"<p>If more than one family name is required, they must be provided as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Williams"
}
},
"given":{
"description":"<p>If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"2",
"items":{
"type":"string",
"maxLength":"100",
"example":"James McAfee"
}
},
"prefix":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Dr."
}
},
"suffix":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"M.D."
}
},
"period":{
"type":"object",
"description":"<p>Must not include an <code>end</code> date.</p>",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2020-12-01T00:00:00.000Z"
}
}
}
}
}
}
Nested Schema : telecom
Type: array
A contact detail (such as a telephone number or an email address) by which the patient may be contacted.
Show Source
{
"description":"<p>A contact detail (such as a telephone number or an email address) by which the patient may be contacted.</p>\n",
"type":"array",
"items":{
"type":"object",
"required":[
"system",
"use",
"value"
],
"properties":{
"system":{
"type":"string",
"enum":[
"phone",
"fax",
"email",
"pager",
"other"
]
},
"value":{
"type":"string",
"maxLength":"100"
},
"use":{
"type":"string",
"enum":[
"home",
"work",
"temp",
"old",
"mobile"
]
},
"rank":{
"type":"integer"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2028-05-17T15:33:18.000Z"
}
}
}
}
}
}
Nested Schema : items
Type: object
Must not contain the text
field.
Show Source
{
"type":"object",
"description":"<p>Must not contain the <code>text</code> field.</p>\n",
"required":[
"use"
],
"properties":{
"use":{
"type":"string",
"enum":[
"home",
"work",
"temp",
"old"
]
},
"type":{
"type":"string",
"enum":[
"postal",
"physical",
"both"
]
},
"line":{
"type":"array",
"items":{
"type":"string",
"maxLength":"100",
"example":"1212 Faircastle Drive"
},
"example":[
"1212 Faircastle Drive",
"Apartment 406"
]
},
"city":{
"type":"string",
"example":"KC"
},
"district":{
"type":"string",
"example":"Jackson"
},
"state":{
"type":"string",
"example":"KS"
},
"postalCode":{
"type":"string",
"example":"64199"
},
"country":{
"type":"string",
"example":"United States of America"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"example":"2032-05-17T15:33:18.000Z"
}
}
}
}
}
Nested Schema : line
Type: array
Show Source
{
"type":"array",
"items":{
"type":"string",
"maxLength":"100",
"example":"1212 Faircastle Drive"
},
"example":[
"1212 Faircastle Drive",
"Apartment 406"
]
}
Example:
[
"1212 Faircastle Drive",
"Apartment 406"
]
Nested Schema : period
Type: object
Show Source
{
"type":"object",
"properties":{
"start":{
"type":"string",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"example":"2032-05-17T15:33:18.000Z"
}
}
}
Nested Schema : items
Type: object
Must be a reference to a Practitioner.
Show Source
{
"description":"<p>Must be a reference to a Practitioner.</p>",
"type":"object",
"properties":{
"reference":{
"type":"string",
"example":"Practitioner/4646007"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"required":[
"language"
],
"properties":{
"language":{
"type":"object",
"properties":{
"coding":{
"type":"array",
"items":{
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"urn:ietf:bcp:47"
]
},
"code":{
"description":"<p>Must use ISO-639-1 alpha 2 code in lower case.</p>\n",
"type":"string",
"example":"en"
},
"display":{
"type":"string",
"example":"English"
}
}
}
},
"text":{
"type":"string"
}
}
},
"preferred":{
"type":"boolean"
}
}
}
Nested Schema : language
Type: object
Show Source
{
"type":"object",
"properties":{
"coding":{
"type":"array",
"items":{
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"urn:ietf:bcp:47"
]
},
"code":{
"description":"<p>Must use ISO-639-1 alpha 2 code in lower case.</p>\n",
"type":"string",
"example":"en"
},
"display":{
"type":"string",
"example":"English"
}
}
}
},
"text":{
"type":"string"
}
}
}
Nested Schema : coding
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"urn:ietf:bcp:47"
]
},
"code":{
"description":"<p>Must use ISO-639-1 alpha 2 code in lower case.</p>\n",
"type":"string",
"example":"en"
},
"display":{
"type":"string",
"example":"English"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"urn:ietf:bcp:47"
]
},
"code":{
"description":"<p>Must use ISO-639-1 alpha 2 code in lower case.</p>\n",
"type":"string",
"example":"en"
},
"display":{
"type":"string",
"example":"English"
}
}
}
Nested Schema : items
Type: object
Show Source
-
url:
string
Allowed Values: [
"http://hl7.org/fhir/v3/AdministrativeGender",
"http://hl7.org/fhir/v3/NullFlavor"
]
-
valueCode:
string
Allowed Values: [
"F",
"M",
"UNK"
]
{
"type":"object",
"properties":{
"url":{
"type":"string",
"enum":[
"http://hl7.org/fhir/v3/AdministrativeGender",
"http://hl7.org/fhir/v3/NullFlavor"
]
},
"valueCode":{
"type":"string",
"enum":[
"F",
"M",
"UNK"
]
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"assigner":{
"type":"string",
"description":"<p>May only be provided on the first identifier object. Contains a reference to the organization in which the patient is being enrolled.</p>\n",
"example":"Organization/619848"
},
"type":{
"type":"object",
"properties":{
"coding":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"example":"MR"
},
"system":{
"type":"string",
"example":"http://hl7.org/fhir/v2/0203"
}
}
}
}
}
},
"system":{
"type":"string",
"example":"urn:oid:1.1.1.1.1.1"
},
"value":{
"type":"string",
"description":"<p>Must be a unique value.</p>",
"example":"CW1234563"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2019-12-01T00:00:00.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2029-12-01T23:59:59.000Z"
}
}
}
}
}
Nested Schema : period
Type: object
Show Source
-
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
{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2019-12-01T00:00:00.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2029-12-01T23:59:59.000Z"
}
}
}
Nested Schema : type
Type: object
Show Source
{
"type":"object",
"properties":{
"coding":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"example":"MR"
},
"system":{
"type":"string",
"example":"http://hl7.org/fhir/v2/0203"
}
}
}
}
}
}
Nested Schema : coding
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"example":"MR"
},
"system":{
"type":"string",
"example":"http://hl7.org/fhir/v2/0203"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"code":{
"type":"string",
"example":"MR"
},
"system":{
"type":"string",
"example":"http://hl7.org/fhir/v2/0203"
}
}
}
Nested Schema : coding
Type: array
Show Source
{
"type":"array",
"items":{
"description":"<p>See the Marital Status Codes for valid system-code pairs.</p>\n",
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"http://hl7.org/fhir/marital-status",
"http://hl7.org/fhir/v3/MaritalStatus",
"http://hl7.org/fhir/v3/NullFlavor"
]
},
"code":{
"type":"string",
"enum":[
"U",
"A",
"D",
"I",
"L",
"M",
"P",
"S",
"T",
"W",
"UNK"
]
}
}
}
}
Nested Schema : items
Type: object
See the Marital Status Codes for valid system-code pairs.
Show Source
-
code:
string
Allowed Values: [
"U",
"A",
"D",
"I",
"L",
"M",
"P",
"S",
"T",
"W",
"UNK"
]
-
system:
string
Allowed Values: [
"http://hl7.org/fhir/marital-status",
"http://hl7.org/fhir/v3/MaritalStatus",
"http://hl7.org/fhir/v3/NullFlavor"
]
{
"description":"<p>See the Marital Status Codes for valid system-code pairs.</p>\n",
"type":"object",
"properties":{
"system":{
"type":"string",
"enum":[
"http://hl7.org/fhir/marital-status",
"http://hl7.org/fhir/v3/MaritalStatus",
"http://hl7.org/fhir/v3/NullFlavor"
]
},
"code":{
"type":"string",
"enum":[
"U",
"A",
"D",
"I",
"L",
"M",
"P",
"S",
"T",
"W",
"UNK"
]
}
}
}
Nested Schema : items
Type: object
Must not include the text
field.
Show Source
-
family:
array family
Minimum Number of Items: 1
Maximum Number of Items: 1
If more than one family name is required, they must be provided as a single string separated by blank spaces.
-
given:
array given
Minimum Number of Items: 1
Maximum Number of Items: 2
If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.
-
period:
object period
Must not include an end
date.
-
prefix:
array prefix
Minimum Number of Items: 1
Maximum Number of Items: 1
-
suffix:
array suffix
Minimum Number of Items: 1
Maximum Number of Items: 1
-
use(required):
string
Allowed Values: [
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
]
{
"description":"<p>Must not include the <code>text</code> field.</p>\n",
"type":"object",
"required":[
"use"
],
"properties":{
"use":{
"type":"string",
"enum":[
"usual",
"official",
"temp",
"nickname",
"anonymous",
"old",
"maiden"
]
},
"family":{
"description":"<p>If more than one family name is required, they must be provided as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Williams"
}
},
"given":{
"description":"<p>If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"2",
"items":{
"type":"string",
"maxLength":"100",
"example":"James McAfee"
}
},
"prefix":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Dr."
}
},
"suffix":{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"M.D."
}
},
"period":{
"type":"object",
"description":"<p>Must not include an <code>end</code> date.</p>",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2020-12-01T00:00:00.000Z"
}
}
}
}
}
Nested Schema : family
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
If more than one family name is required, they must be provided as a single string separated by blank spaces.
Show Source
{
"description":"<p>If more than one family name is required, they must be provided as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Williams"
}
}
Nested Schema : given
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2
If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.
Show Source
{
"description":"<p>If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.</p>\n",
"type":"array",
"minItems":"1",
"maxItems":"2",
"items":{
"type":"string",
"maxLength":"100",
"example":"James McAfee"
}
}
Nested Schema : period
Type: object
Must not include an end
date.
Show Source
-
start:
string
Must include a time component with a timezone.
Example: 2020-12-01T00:00:00.000Z
{
"type":"object",
"description":"<p>Must not include an <code>end</code> date.</p>",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>",
"example":"2020-12-01T00:00:00.000Z"
}
}
}
Nested Schema : prefix
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"Dr."
}
}
Nested Schema : suffix
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"minItems":"1",
"maxItems":"1",
"items":{
"type":"string",
"maxLength":"100",
"example":"M.D."
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"required":[
"system",
"use",
"value"
],
"properties":{
"system":{
"type":"string",
"enum":[
"phone",
"fax",
"email",
"pager",
"other"
]
},
"value":{
"type":"string",
"maxLength":"100"
},
"use":{
"type":"string",
"enum":[
"home",
"work",
"temp",
"old",
"mobile"
]
},
"rank":{
"type":"integer"
},
"period":{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2028-05-17T15:33:18.000Z"
}
}
}
}
}
Nested Schema : period
Type: object
Show Source
-
end:
string
Must include a time component with a timezone.
Example: 2028-05-17T15:33:18.000Z
-
start:
string
Must include a time component with a timezone.
Example: 2012-05-17T15:33:18.000Z
{
"type":"object",
"properties":{
"start":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2012-05-17T15:33:18.000Z"
},
"end":{
"type":"string",
"description":"<p>Must include a time component with a timezone.</p>\n",
"example":"2028-05-17T15:33:18.000Z"
}
}
}