📘 FHIR documentation for Patient.
\n\n🛡️ **Authorization behavior:**\n- **Patients** (using `patient/*.read` scope) can access only their own Patient resource.\n- **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n- **Practitioners** (using `user/*.read` scope) must explicitly pass the `_id` query parameter to access another patient's data.\n", "parameters": [ { "name": "_id", "in": "query", "description": "Logical ID of the Patient resource. Required for practitioners to access specific patients when using `user/*.read`", "schema": { "type": "integer" }, "example": 6077169 }, { "name": "identifier", "in": "query", "description": "A patient business identifier such as an MRN or MPI. Use token syntax `{system}|{value}` when the issuing system is known, or just the identifier value when the server can infer the system.", "schema": { "type": "string" }, "example": "http://hospital.smarthealthit.org|90332213" }, { "name": "name", "in": "query", "description": "A text search against patient name. Current implementation behavior primarily matches family names across all `Patient.name` entries (for example `official`, `old`) and may not return results for given-name-only input.", "schema": { "type": "string" }, "example": "Jones" }, { "name": "birthdate", "in": "query", "description": "The patient's date of birth. Use in combination with `name` for better match precision. Format is `YYYY-MM-DD`.", "schema": { "type": "string", "format": "date" }, "example": "1990-07-04" }, { "name": "gender", "in": "query", "description": "The patient's administrative gender. Use in combination with `name` for better match precision. Token values are `male`, `female`, `other`, or `unknown`.", "schema": { "type": "string" }, "example": "female" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Patient" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Patient/{id}": { "get": { "tags": [ "Patient" ], "description": "This interaction searches Patient based on patient id. Search interactions take patient id in path for a GET.📘 FHIR documentation for Patient.
\n\n🛡️ **Authorization behavior:**\n- **Patients** (using `patient/*.read` scope) can access only their own Patient resource.\n- **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n- **Practitioners** (using `user/*.read` scope) must explicitly pass the `id` path parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource", "required": true, "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Patient" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Patient/_search": { "post": { "tags": [ "Patient" ], "description": "This interaction searches a set of Patients based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for Patient.
\n\n🛡️ **Authorization behavior:**\n- **Patients** (using `patient/*.read` scope) can access only their own Patient resource.\n- **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n- **Practitioners** (using `user/*.read` scope) must include `_id` in the request body to query another patient.\n", "operationId": "Patients Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "_id": { "type": "integer", "description": "The resource identity", "example": 6077169 }, "identifier": { "type": "string", "description": "A patient business identifier such as an MRN or MPI. Use token syntax `{system}|{value}` when the issuing system is known, or provide only the identifier value when the server can infer the system.", "example": "http://hospital.smarthealthit.org|90332213" }, "name": { "type": "string", "description": "A text search against patient name. Current implementation behavior primarily matches family names across all `Patient.name` entries (for example `official`, `old`) and may not return results for given-name-only input.", "example": "Jones" }, "birthdate": { "type": "string", "format": "date", "description": "The patient's date of birth. Use in combination with `name` for better match precision. Format is `YYYY-MM-DD`.", "example": "1990-07-04" }, "gender": { "type": "string", "description": "The patient's administrative gender. Use in combination with `name` for better match precision. Token values: `male`, `female`, `other`, `unknown`.", "example": "female" } }, "required": [ "_id" ] } } } }, "responses": { "200": { "description": "Patient bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Patient" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/AllergyIntolerance": { "get": { "tags": [ "AllergyIntolerance" ], "description": "This interaction searches a set of AllergyIntolerances based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for AllergyIntolerance.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who the sensitivity is for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/AllergyIntolerance/{id}": { "get": { "tags": [ "AllergyIntolerance" ], "description": "This interaction searches AllergyIntolerance based on allergy intolerance id.Search interactions take allergy intolerance id in path for a GET.📘 FHIR documentation for AllergyIntolerance.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 213 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/AllergyIntolerance/_search": { "post": { "tags": [ "AllergyIntolerance" ], "description": "This interaction searches a set of AllergyIntolerances based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for AllergyIntolerance.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "AllergyIntolerances Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "Who allergy intolerance is for", "example": 6077169 } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "AllergyIntolerance bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/CarePlan": { "get": { "tags": [ "CarePlan" ], "description": "This interaction searches a set of CarePlans based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for CarePlan.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who the care plan is for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "category", "in": "query", "description": "Type of care plan", "schema": { "type": "string" }, "example": 736373009 } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarePlan" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/CarePlan/{id}": { "get": { "tags": [ "CarePlan" ], "description": "This interaction searches Careplan based on care plan id.Search interactions take careplan id in path for a GET.📘 FHIR documentation for CarePlan.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 153649881 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/CarePlan/_search": { "post": { "tags": [ "CarePlan" ], "description": "This interaction searches a set of CarePlans based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for CarePlan.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "CarePlans Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "Who care plan is for", "example": 6077169 }, "category": { "type": "string", "description": "Type of care plan", "example": 736373009 } }, "required": [ "patient", "category" ] } } } }, "responses": { "200": { "description": "CarePlan bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarePlan" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/CareTeam": { "get": { "tags": [ "CareTeam" ], "description": "This interaction searches a set of CareTeams based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for CareTeam.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who care team is for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "status", "in": "query", "description": "proposed | active | suspended | inactive | entered-in-error", "schema": { "type": "string" }, "example": "active" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CareTeam" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/CareTeam/{id}": { "get": { "tags": [ "CareTeam" ], "description": "This interaction searches CareTeam based on careteam id.Search interactions take care team id in path for a GET.📘 FHIR documentation for CareTeam.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "00000000-0000-0000-0000-000000003238" } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/CareTeam/_search": { "post": { "tags": [ "CareTeam" ], "description": "This interaction searches a set of CareTeam based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for CareTeam.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "CareTeam Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "Who careteam is for", "example": 6077169 }, "status": { "type": "string", "description": "proposed | active | suspended | inactive | entered-in-error", "example": "active" } }, "required": [ "patient", "status" ] } } } }, "responses": { "200": { "description": "CareTeam bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CareTeam" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Condition": { "get": { "tags": [ "Condition" ], "description": "This interaction searches a set of Conditions based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Condition.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who condition is for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "category", "in": "query", "description": "The category of the condition.\nCommon US Core Condition categories include `problem-list-item` and `encounter-diagnosis`.\nAdditional categories now supported include:\n- `sdoh` - SDOH Assessment\n- `functional-status` - Functional Status\n- `disability-status` - Disability Status\n- `cognitive-status` - Mental/Cognitive Status\n", "schema": { "type": "string" }, "example": "sdoh" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Condition/{id}": { "get": { "tags": [ "Condition" ], "description": "This interaction searche Condition based on condition id.Search interactions take condition id in path for a GET.📘 FHIR documentation for Condition.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 511 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Condition" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Condition/_search": { "post": { "tags": [ "Condition" ], "description": "This interaction searches a set of Conditions based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for Condition.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "Conditions Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "Who condition is for", "example": 6077169 }, "category": { "type": "string", "description": "The category of the condition. Common US Core categories include `problem-list-item` and `encounter-diagnosis`.\nAdditional categories include `sdoh`, `functional-status`, `disability-status`, and `cognitive-status`.\n", "example": "sdoh" } }, "required": [ "patient", "category" ] } } } }, "responses": { "200": { "description": "Condition bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/DiagnosticReport": { "get": { "tags": [ "DiagnosticReport" ], "description": "This interaction searches a set of DiagnosticReports based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for DiagnosticReport.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "The subject of the report if a patient", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "category", "in": "query", "description": "The diagnostic service category", "schema": { "type": "string" }, "example": "LAB" }, { "name": "code", "in": "query", "description": "The code for the report as defined by LOINC", "schema": { "type": "string" }, "example": "58410-2" }, { "name": "date", "in": "query", "description": "The clinically relevant time of the report", "schema": { "type": "string", "format": "date" }, "example": "2024-06-01" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticReport" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/DiagnosticReport/{id}": { "get": { "tags": [ "DiagnosticReport" ], "description": "This interaction searches DiagnosticReport based on diagnostic report id.Search interactions take diagnostic report id in path for a GET.📘 FHIR documentation for DiagnosticReport.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 9617706119946351 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/DiagnosticReport/_search": { "post": { "tags": [ "DiagnosticReport" ], "description": "This interaction searches a set of DiagnosticReports based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for DiagnosticReport.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "DiagnosticReports Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "The subject of the report if a patient", "example": 6077169 }, "category": { "type": "string", "description": "The diagnostic service category", "example": "LAB" }, "code": { "type": "string", "description": "The code for the report as defined by LOINC", "example": "58410-2" }, "date": { "type": "string", "format": "date", "description": "The clinically relevant time of the report", "example": "2024-06-01" } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "DiagnosticReport bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticReport" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Device": { "get": { "tags": [ "Device" ], "description": "This interaction searches a set of Devices based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Device.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who device is for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Device/{id}": { "get": { "tags": [ "Device" ], "description": "This interaction searches Device based on device id.Search interactions take device id in path for a GET.📘 FHIR documentation for Device.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 2 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Device/_search": { "post": { "tags": [ "Device" ], "description": "This interaction searches a set of Device based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for Device.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "Device Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "Who device is for", "example": 6077169 } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "Device bundle", "content": { "application/fhir+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/DocumentReference": { "get": { "tags": [ "DocumentReference" ], "description": "This interaction searches a set of DocumentReferences based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for DocumentReference.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who/what is the subject of the document", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "_id", "in": "query", "description": "Logical id of the document reference", "schema": { "type": "string" }, "example": 153649915 }, { "name": "type", "in": "query", "description": "Kind of document (LOINC if possible)", "schema": { "type": "string" }, "example": "34133-9" }, { "name": "category", "in": "query", "description": "Categorization of document", "schema": { "type": "string" }, "example": "clinical-note" }, { "name": "date", "in": "query", "description": "When this document reference was created", "schema": { "type": "string", "format": "date" }, "example": "2024-06-01" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/DocumentReference/{id}": { "get": { "tags": [ "DocumentReference" ], "description": "This interaction searches DocumentReference based on document reference id.Search interactions take document reference id in path for a GET.📘 FHIR documentation for DocumentReference.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 153649915 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/DocumentReference/$docref": { "get": { "tags": [ "DocumentReference" ], "description": "This operation returns references to documents related to a patient and aligns to the US Core Fetch DocumentReference operation.\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "operationId": "DocumentReferenceFetchDocref", "parameters": [ { "name": "patient", "in": "query", "required": true, "description": "The id of the patient resource.", "schema": { "type": "integer" }, "example": 6077169 }, { "name": "start", "in": "query", "description": "Start of the care date range for matching documents.", "schema": { "type": "string", "format": "date-time" }, "example": "2024-01-01T00:00:00Z" }, { "name": "end", "in": "query", "description": "End of the care date range for matching documents.", "schema": { "type": "string", "format": "date-time" }, "example": "2024-12-31T23:59:59Z" }, { "name": "type", "in": "query", "description": "Document type code such as the LOINC code for CCD.", "schema": { "type": "string" }, "example": "34133-9" }, { "name": "on-demand", "in": "query", "description": "Whether to request only on-demand documents.", "schema": { "type": "boolean" }, "example": false }, { "name": "profile", "in": "query", "description": "Canonical profile URL used to request documents for a specific profile.", "schema": { "type": "string" }, "example": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" } ], "responses": { "200": { "description": "Searchset bundle containing DocumentReference resources.", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/DocumentReference/_search": { "post": { "tags": [ "DocumentReference" ], "description": "This interaction searches a set of DocumentReferences based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for DocumentReference.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "DocumentReferences Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "Who/what is the subject of the document", "example": 6077169 }, "_id": { "type": "string", "description": "Logical id of the document reference", "example": 153649915 }, "type": { "type": "string", "description": "Kind of document (LOINC if possible)", "example": "34133-9" }, "category": { "type": "string", "description": "Categorization of document", "example": "clinical-note" }, "date": { "type": "string", "format": "date", "description": "When this document reference was created", "example": "2024-06-01" } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "DocumentReference bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Encounter": { "get": { "tags": [ "Encounter" ], "description": "This interaction searches a set of Encounters based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Encounter.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "_id", "in": "query", "description": "Logical id of the encounter.", "schema": { "type": "string" }, "example": 5307983 }, { "name": "date", "in": "query", "description": "A date within the encounter period.", "schema": { "type": "string", "format": "date" }, "example": "2024-06-01" }, { "name": "identifier", "in": "query", "description": "Business identifier assigned to the encounter by the source system, visit management system, or EHR. Use token syntax `{system}|{value}` when the identifier namespace is known.", "schema": { "type": "string" }, "example": "http://example.org/encounters|ENC-5307983" }, { "name": "patient", "in": "query", "description": "The patient present at the encounter.", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "status", "in": "query", "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled", "schema": { "type": "string" }, "example": "finished" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Encounter" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Encounter/{id}": { "get": { "tags": [ "Encounter" ], "description": "This interaction searches Encounter based on encounter id.Search interactions take encounter id in path for a GET.📘 FHIR documentation for Encounter.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 5307983 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Encounter" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Goal": { "get": { "tags": [ "Goal" ], "description": "This interaction searches a set of Goals based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Goal.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who this goal is intended for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Goal" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Goal/{id}": { "get": { "tags": [ "Goal" ], "description": "This interaction searches Goal based on goal id.Search interactions take goal id in path for a GET.📘 FHIR documentation for Goal.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 153649896 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Goal" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Goal/_search": { "post": { "tags": [ "Goal" ], "description": "This interaction searches a set of Goal based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for Goal.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "Goal Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": " ", "example": 6077169 } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "DiagnosticReport bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Goal" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Immunization": { "get": { "tags": [ "Immunization" ], "description": "This interaction searches a set of Immunizations based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Immunization.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who this immunization is intended for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Immunization" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Immunization/{id}": { "get": { "tags": [ "Immunization" ], "description": "This interaction searches Immunization based on immunization id.Search interactions take immunization id in path for a GET.📘 FHIR documentation for Immunization.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 95 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Immunization" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Immunization/_search": { "post": { "tags": [ "Immunization" ], "description": "This interaction searches a set of Immunizations based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for Immunization.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "Immunizations Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "The patient for the vaccination record", "example": 6077169 } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "Immunization bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Immunization" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Location": { "get": { "tags": [ "Location" ], "description": "This interaction searches a set of Locations based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Location.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "name", "in": "query", "description": "A (portion of the) location's name", "schema": { "type": "string", "example": "Family Medicine" } }, { "name": "address", "in": "query", "description": "A (portion of the) address of the location", "schema": { "type": "string", "example": "123 Main St" } }, { "name": "address-city", "in": "query", "description": "A city specified in an address", "schema": { "type": "string", "example": "Kansas City" } }, { "name": "address-state", "in": "query", "description": "A state specified in an address", "schema": { "type": "string", "example": "MO" } }, { "name": "address-postalcode", "in": "query", "description": "A postal code specified in an address", "schema": { "type": "string", "example": "64154" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Location/{id}": { "get": { "tags": [ "Location" ], "description": "This interaction searches Location based on location id.Search interactions take location id in path for a GET.📘 FHIR documentation for Location.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "174" } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/MedicationRequest": { "get": { "tags": [ "MedicationRequest" ], "description": "This interaction searches a set of MedicationRequests based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for MedicationRequest.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Who this goal is intended for", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "intent", "in": "query", "description": "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", "schema": { "type": "string" }, "example": "order" }, { "name": "status", "in": "query", "description": "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown", "schema": { "type": "string" }, "example": "active" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MedicationRequest" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/MedicationRequest/{id}": { "get": { "tags": [ "MedicationRequest" ], "description": "This interaction searches MedicationRequest based on medication request id.Search interactions take medication request id in path for a GET.📘 FHIR documentation for MedicationRequest.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 407 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/MedicationRequest/_search": { "post": { "tags": [ "MedicationRequest" ], "description": "This interaction searches a set of MedicationRequest based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for MedicationRequest.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "MedicationRequest Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": " ", "example": 6077169 }, "intent": { "type": "string", "description": "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", "example": "order" }, "status": { "type": "string", "description": "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown", "example": "active" } }, "required": [ "patient", "intent" ] } } } }, "responses": { "200": { "description": "DiagnosticReport bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MedicationRequest" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Observation": { "get": { "tags": [ "Observation" ], "description": "This interaction searches a set of Observations based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Observation.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "The subject that the observation is about (if patient)", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "category", "in": "query", "description": "The classification of the observation. Common US Core Observation profile categories include:\n- `laboratory` — US Core Laboratory Result Observation Profile\n- `vital-signs` — US Core Vital Signs Profile (Blood Pressure, BMI, Body Height/Weight/Temperature, Head Circumference, Heart Rate, Pulse Oximetry, Respiratory Rate, and pediatric profiles)\n- `social-history` — US Core Observation Occupation, Sexual Orientation, Smoking Status profiles\n- `survey` — US Core Observation Screening Assessment, Pregnancy Intent/Status profiles\nFor screening and assessment use cases, US Core supports additional category values in addition to `survey`, including:\n- `sdoh` - SDOH Assessment\n- `functional-status` - Functional Status\n- `disability-status` - Disability Status\n- `cognitive-status` - Mental/Cognitive Status\n", "schema": { "type": "string" }, "example": "laboratory" }, { "name": "code", "in": "query", "description": "The LOINC or SNOMED code of the observation type. Use token syntax `{system}|{code}` to specify a code system, or just the code value alone.\n\nCommon US Core Observation LOINC codes organized by profile:\n\n**Vital Signs:**\n- `8867-4` — Heart rate\n- `8310-5` — Body temperature\n- `8302-2` — Body height\n- `29463-7` — Body weight\n- `39156-5` — BMI\n- `2708-6` — Oxygen saturation\n- `9279-1` — Respiratory rate\n- `85354-9` — Systolic and Diastolic BP\n\n**Laboratory Results:**\n- `2345-7` — Glucose (serum/plasma)\n- `2951-2` — Sodium\n\n**Social History:**\n- `72166-2` — Smoking status\n- `11341-5` — Occupation\n\n**Sexual Orientation (US Core 6.1.0):**\n- `76690-7` — Sexual orientation\n\n**Pregnancy (US Core 6.1.0):**\n- `82810-3` — Pregnancy status\n- `76438-3` — Pregnancy intent\n", "schema": { "type": "string" }, "examples": { "loinc_code_only": { "value": "8867-4", "description": "Heart rate only" }, "loinc_with_system": { "value": "http://loinc.org|8867-4", "description": "Heart rate with LOINC system" }, "sexual_orientation": { "value": "http://loinc.org|76690-7", "description": "Sexual orientation (6.1.0)" }, "pregnancy_status": { "value": "http://loinc.org|82810-3", "description": "Pregnancy status (6.1.0)" } } }, { "name": "date", "in": "query", "description": "Clinically relevant date/time of the observation. Supports prefixes `eq`, `lt`, `gt`, `ge`, `le` (e.g. `ge2024-01-01`). If the obtained element is a period, matches any date that falls within the period.", "schema": { "type": "string", "format": "date" }, "example": "2024-06-01" }, { "name": "status", "in": "query", "description": "The status of the observation. Required for the `patient + category + status` SHALL search combination. Allowed values: `registered`, `preliminary`, `final`, `amended`, `corrected`, `cancelled`, `entered-in-error`, `unknown`.\n", "schema": { "type": "string", "enum": [ "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", "unknown" ] }, "example": "final" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Observation" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Observation/{id}": { "get": { "tags": [ "Observation" ], "description": "This interaction searches Observation based on observation id.Search interactions take observation id in path for a GET.📘 FHIR documentation for Observation.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 153649902 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Observation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Observation/_search": { "post": { "tags": [ "Observation" ], "description": "This interaction searches a set of Observations based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for Observation.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "Observations Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "The subject that the observation is about (if patient)", "example": 6077169 }, "category": { "type": "string", "description": "The classification of the observation. Common US Core profiles use `laboratory`, `vital-signs`, `social-history`, `survey`, `exam`, `procedure`.\nAdditional category values include `sdoh`, `functional-status`, `disability-status`, and `cognitive-status`.\n", "example": "laboratory" }, "code": { "type": "string", "description": "The LOINC or SNOMED code of the observation type. Use token syntax `{system}|{code}` to specify a code system.\nCommon US Core codes: vital signs (8867-4 heart rate, 8310-5 temperature, 8302-2 height, 29463-7 weight, 39156-5 BMI, 85354-9 BP), labs (2345-7 glucose, 2951-2 sodium), social history (72166-2 smoking status, 11341-5 occupation), sexual orientation (76690-7), pregnancy (82810-3 status, 76438-3 intent).\n", "example": "http://loinc.org|8867-4" }, "date": { "type": "string", "format": "date", "description": "Clinically relevant date/time of the observation. Supports prefixes `eq`, `lt`, `gt`, `ge`, `le`. If the obtained element is a period, matches any date that falls within the period.", "example": "2024-06-01" }, "status": { "type": "string", "description": "The status of the observation. Required for the `patient + category + status` SHALL search combination. Allowed values: `registered`, `preliminary`, `final`, `amended`, `corrected`, `cancelled`, `entered-in-error`, `unknown`.", "enum": [ "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", "unknown" ], "example": "final" } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "Observation bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Observation" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Organization": { "get": { "tags": [ "Organization" ], "description": "This interaction searches a set of Organizations based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Organization.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "name", "in": "query", "description": "A portion of the organization's name.", "schema": { "type": "string" }, "example": "Family Medicine" }, { "name": "address", "in": "query", "description": "A server defined search that matches address text.", "schema": { "type": "string" }, "example": "123 Main St" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Organization/{id}": { "get": { "tags": [ "Organization" ], "description": "This interaction searches Organization based on organization id.Search interactions take organization id in path for a GET.📘 FHIR documentation for Organization.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 174 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Practitioner": { "get": { "tags": [ "Practitioner" ], "description": "This interaction searches a set of Practitioners based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Practitioner.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "_id", "in": "query", "description": "Logical id of the practitioner.", "schema": { "type": "string" }, "example": 3238 }, { "name": "identifier", "in": "query", "description": "A practitioner business identifier such as an NPI. Use token syntax `{system}|{value}` when the identifier system is known.", "schema": { "type": "string" }, "example": "http://hl7.org/fhir/sid/us-npi|1234567890" }, { "name": "name", "in": "query", "description": "A server defined search that may match any HumanName field.", "schema": { "type": "string" }, "example": "Smith" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Practitioner" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Practitioner/{id}": { "get": { "tags": [ "Practitioner" ], "description": "This interaction searches Practitioner based on practitioner id.Search interactions take practitioner id in path for a GET.📘 FHIR documentation for Practitioner.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 3238 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Procedure": { "get": { "tags": [ "Procedure" ], "description": "This interaction searches a set of Procedures based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 FHIR documentation for Procedure.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Search by subject - a patient", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "date", "in": "query", "description": "When the procedure was performed", "schema": { "type": "string", "format": "date" }, "example": "2024-06-01" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Procedure" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Procedure/{id}": { "get": { "tags": [ "Procedure" ], "description": "This interaction searches Procedure based on procedure id.Search interactions take procedure id in path for a GET.📘 FHIR documentation for Procedure.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "description": "The logical resource id associated with the Resource.", "required": true, "schema": { "type": "integer", "example": 5307986 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Procedure" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Procedure/_search": { "post": { "tags": [ "Procedure" ], "description": "This interaction searches a set of Procedures based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.📘 FHIR documentation for Procedure.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "Procedures Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "description": "Search by subject - a patient", "example": 6077169 }, "date": { "type": "string", "format": "date", "description": "When the procedure was performed", "example": "2024-06-01" } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "Procedure bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Procedure" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Provenance/{id}": { "get": { "tags": [ "Provenance" ], "description": "This interaction searches Provenance based on provenance id.Search interactions take provenance id in path for a GET.📘 FHIR documentation for Provenance.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 9617706 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Provenance" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/MedicationDispense": { "get": { "tags": [ "MedicationDispense" ], "description": "This interaction searches a set of MedicationDispenses based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 US Core MedicationDispense profile.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Returns dispenses for a specific patient", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "status", "in": "query", "description": "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown", "schema": { "type": "string" }, "example": "completed" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MedicationDispense" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/MedicationDispense/{id}": { "get": { "tags": [ "MedicationDispense" ], "description": "This interaction retrieves a MedicationDispense resource by id.📘 US Core MedicationDispense profile.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 123 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/MedicationDispense/_search": { "post": { "tags": [ "MedicationDispense" ], "description": "This interaction searches a set of MedicationDispenses based on some filter criteria encoded as an application/x-www-form-urlencoded submission for a POST.📘 US Core MedicationDispense profile.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "MedicationDispense Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "example": 6077169 }, "status": { "type": "string", "description": "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown", "example": "completed" } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "MedicationDispense bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MedicationDispense" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/RelatedPerson": { "get": { "tags": [ "RelatedPerson" ], "description": "This interaction searches a set of RelatedPersons based on some filter criteria. Search interactions take a series of query parameters for a GET.📘 US Core RelatedPerson profile.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "The patient the person is related to", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } }, { "name": "_id", "in": "query", "description": "The logical resource id associated with RelatedPerson", "schema": { "type": "string" }, "example": 456 } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPerson" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/RelatedPerson/{id}": { "get": { "tags": [ "RelatedPerson" ], "description": "This interaction retrieves a RelatedPerson resource by id.📘 US Core RelatedPerson profile.
\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 456 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/RelatedPerson/_search": { "post": { "tags": [ "RelatedPerson" ], "description": "This interaction searches a set of RelatedPersons based on some filter criteria encoded as an application/x-www-form-urlencoded submission for a POST.\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "RelatedPerson Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "example": 6077169 }, "_id": { "type": "string", "description": "The logical resource id associated with RelatedPerson", "example": 456 } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "RelatedPerson bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPerson" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Coverage": { "get": { "tags": [ "Coverage" ], "description": "This interaction searches a set of Coverage resources based on some filter criteria. Search interactions take a series of query parameters for a GET.\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "patient", "in": "query", "description": "Retrieve coverages for a patient", "schema": { "type": "string" }, "examples": { "patient_id": { "summary": "Logical patient id", "value": "6077169" }, "patient_reference": { "summary": "Relative Patient reference", "value": "Patient/6077169" } } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Coverage" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Coverage/{id}": { "get": { "tags": [ "Coverage" ], "description": "This interaction retrieves a Coverage resource by id.\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient's data.\n", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 789 } }, { "name": "patient", "in": "query", "description": "Patient ID to filter the search.", "schema": { "type": "integer", "example": 6077169 } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Coverage" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/Coverage/_search": { "post": { "tags": [ "Coverage" ], "description": "This interaction searches a set of Coverage resources based on some filter criteria encoded as an application/x-www-form-urlencoded submission for a POST.\n\n🛡️ **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient's data.\n", "operationId": "Coverage Search using POST", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "patient": { "type": "integer", "example": 6077169 } }, "required": [ "patient" ] } } } }, "responses": { "200": { "description": "Coverage bundle", "content": { "application/fhir+json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Coverage" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "x-us-core-profiles": { "version": "6.1.0", "supported": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height", "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance" ] }, "schemas": { "Account_text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "Account_coverage": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "Account_meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Account_type_coding" } } } }, "Account_type_coding": { "required": [ "code", "display", "system" ], "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "ActivityDefinition_telecom": { "required": [ "system", "use", "value" ], "properties": { "system": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" }, "use": { "minLength": 1, "type": "string" } } }, "ActivityDefinition_valueCodeableConcept": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Account_type_coding" } } } }, "AllergyIntolerance": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance", "required": [ "asserter", "category", "clinicalStatus", "code", "criticality", "id", "identifier", "lastOccurrence", "meta", "note", "onsetDateTime", "patient", "reaction", "recordedDate", "recorder", "resourceType", "text", "type", "verificationStatus" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "description": "Business identifiers assigned to the allergy or intolerance record by source systems.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier with a namespace in `system` and a resource-specific value in `value`.", "required": [ "system", "value" ], "type": "object", "properties": { "system": { "description": "Namespace or URI that defines the identifier value.", "minLength": 1, "type": "string" }, "value": { "description": "Identifier value unique within the stated system.", "minLength": 1, "type": "string" } } } }, "clinicalStatus": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "verificationStatus": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "type": { "minLength": 1, "type": "string" }, "category": { "type": "array", "items": { "type": "object", "properties": {} } }, "criticality": { "minLength": 1, "type": "string" }, "code": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "patient": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "onsetDateTime": { "minLength": 1, "type": "string" }, "recordedDate": { "minLength": 1, "type": "string" }, "recorder": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "asserter": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "lastOccurrence": { "minLength": 1, "type": "string" }, "note": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "reaction": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "description", "onset", "severity" ], "type": "object", "properties": { "substance": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "manifestation": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": { "minLength": 1, "type": "string" }, "onset": { "minLength": 1, "type": "string" }, "severity": { "minLength": 1, "type": "string" }, "exposureRoute": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Appointment_basedOn": { "required": [ "reference" ], "properties": { "reference": { "minLength": 1, "type": "string" } } }, "CarePlan": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan", "required": [ "activity", "addresses", "author", "basedOn", "careTeam", "category", "contained", "created", "description", "encounter", "goal", "id", "identifier", "instantiatesUri", "intent", "meta", "partOf", "period", "replaces", "resourceType", "status", "subject", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "contained": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "id", "resourceType" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "clinicalStatus": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "verificationStatus": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "code": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } }, "subject": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "identifier": { "description": "Business identifiers assigned to the care plan by source workflows or the originating clinical system.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier value for the care plan when the issuing system is implied by implementation context.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Business identifier value for the care plan.", "minLength": 1, "type": "string" } } } }, "instantiatesUri": { "type": "array", "items": { "type": "object", "properties": {} } }, "basedOn": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display" ], "type": "object", "properties": { "display": { "minLength": 1, "type": "string" } } } }, "replaces": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display" ], "type": "object", "properties": { "display": { "minLength": 1, "type": "string" } } } }, "partOf": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display" ], "type": "object", "properties": { "display": { "minLength": 1, "type": "string" } } } }, "status": { "minLength": 1, "type": "string" }, "intent": { "minLength": 1, "type": "string" }, "category": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "description": { "minLength": 1, "type": "string" }, "subject": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "encounter": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "period": { "required": [ "end" ], "type": "object", "properties": { "end": { "minLength": 1, "type": "string" } } }, "created": { "minLength": 1, "type": "string" }, "author": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "careTeam": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "addresses": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "goal": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "activity": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "outcomeCodeableConcept": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "outcomeReference": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "detail": { "required": [ "code", "doNotPerform", "location", "performer", "scheduledTiming", "status", "statusReason" ], "type": "object", "properties": { "code": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "status": { "minLength": 1, "type": "string" }, "statusReason": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } }, "doNotPerform": { "type": "boolean" }, "scheduledTiming": { "required": [ "repeat" ], "type": "object", "properties": { "repeat": { "required": [ "frequency", "period", "periodUnit" ], "type": "object", "properties": { "frequency": { "type": "number" }, "period": { "type": "number" }, "periodUnit": { "minLength": 1, "type": "string" } } } } }, "location": { "required": [ "display" ], "type": "object", "properties": { "display": { "minLength": 1, "type": "string" } } }, "performer": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "CarePlan_identifier": { "description": "Simple business identifier structure used when only an identifier value is carried in this specification.", "required": [ "value" ], "properties": { "value": { "description": "Business identifier value assigned by the source system.", "minLength": 1, "type": "string" } } }, "CareTeam": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam", "required": [ "category", "contained", "encounter", "id", "identifier", "managingOrganization", "meta", "name", "participant", "period", "resourceType", "status", "subject", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "contained": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "id", "resourceType" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "name": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "family" ], "type": "object", "properties": { "family": { "minLength": 1, "type": "string" }, "given": { "type": "array", "items": { "type": "object", "properties": {} } } } } } } } }, "identifier": { "description": "Business identifiers assigned to the care team by the source application or care coordination workflow.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier value for the care team when the identifier system is implementation-defined.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Business identifier value for the care team.", "minLength": 1, "type": "string" } } } }, "status": { "minLength": 1, "type": "string" }, "category": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "name": { "minLength": 1, "type": "string" }, "subject": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "encounter": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "period": { "required": [ "end" ], "type": "object", "properties": { "end": { "minLength": 1, "type": "string" } } }, "participant": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "role": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "member": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "onBehalfOf": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "period": { "required": [ "end" ], "type": "object", "properties": { "end": { "minLength": 1, "type": "string" } } } } } }, "managingOrganization": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Condition": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns", "required": [ "bodySite", "category", "clinicalStatus", "code", "id", "meta", "onsetDateTime", "resourceType", "severity", "subject", "text", "verificationStatus" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "clinicalStatus": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "verificationStatus": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "category": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "severity": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "code": { "required": [ "coding", "text" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "text": { "minLength": 1, "type": "string" } } }, "bodySite": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "text": { "minLength": 1, "type": "string" } } } }, "subject": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "onsetDateTime": { "minLength": 1, "type": "string" }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "DiagnosticReport": { "x-us-core-profiles": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note" ], "required": [ "entry", "id", "meta", "resourceType", "type" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" }, "entry": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "fullUrl" ], "type": "object", "properties": { "fullUrl": { "minLength": 1, "type": "string" }, "resource": { "required": [ "category", "code", "effectiveDateTime", "encounter", "id", "identifier", "issued", "meta", "performer", "presentedForm", "resourceType", "result", "status", "subject", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "value" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } } } }, "status": { "minLength": 1, "type": "string" }, "category": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } } }, "code": { "required": [ "coding", "text" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "text": { "minLength": 1, "type": "string" } } }, "subject": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "encounter": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "effectiveDateTime": { "minLength": 1, "type": "string" }, "issued": { "minLength": 1, "type": "string" }, "performer": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "result": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "presentedForm": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "contentType", "data", "language", "title" ], "type": "object", "properties": { "contentType": { "minLength": 1, "type": "string" }, "language": { "minLength": 1, "type": "string" }, "data": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" } } } } } } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Device": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device", "required": [ "id", "identifier", "meta", "resourceType", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "description": "Business identifiers assigned to the device record by source systems, manufacturers, or implant tracking workflows.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier with a namespace in `system` and a resource-specific value in `value`.", "required": [ "system", "value" ], "type": "object", "properties": { "system": { "description": "Namespace or URI that defines the identifier value.", "minLength": 1, "type": "string" }, "value": { "description": "Identifier value unique within the stated system.", "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "DocumentReference": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference", "required": [ "authenticator", "author", "category", "contained", "content", "context", "custodian", "date", "description", "docStatus", "id", "identifier", "masterIdentifier", "meta", "relatesTo", "resourceType", "securityLabel", "status", "subject", "text", "type" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "contained": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "id", "resourceType" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "name": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "family" ], "type": "object", "properties": { "family": { "minLength": 1, "type": "string" }, "given": { "type": "array", "items": { "type": "object", "properties": {} } } } } } } } }, "masterIdentifier": { "description": "Master identifier assigned to this document by the publishing or source document system.", "required": [ "system", "value" ], "type": "object", "properties": { "system": { "description": "Namespace or URI that defines the master identifier value.", "minLength": 1, "type": "string" }, "value": { "description": "Master identifier value unique within the stated system.", "minLength": 1, "type": "string" } } }, "identifier": { "description": "Additional business identifiers associated with this document reference.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier with a namespace in `system` and a resource-specific value in `value`.", "required": [ "system", "value" ], "type": "object", "properties": { "system": { "description": "Namespace or URI that defines the identifier value.", "minLength": 1, "type": "string" }, "value": { "description": "Identifier value unique within the stated system.", "minLength": 1, "type": "string" } } } }, "status": { "minLength": 1, "type": "string" }, "docStatus": { "minLength": 1, "type": "string" }, "type": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "category": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "subject": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "date": { "minLength": 1, "type": "string" }, "author": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "authenticator": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "custodian": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "relatesTo": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "target": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } } } }, "description": { "minLength": 1, "type": "string" }, "securityLabel": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "content": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "attachment": { "required": [ "contentType", "creation", "hash", "language", "size", "title", "url" ], "type": "object", "properties": { "contentType": { "minLength": 1, "type": "string" }, "language": { "minLength": 1, "type": "string" }, "url": { "minLength": 1, "type": "string" }, "size": { "type": "number" }, "hash": { "minLength": 1, "type": "string" }, "title": { "minLength": 1, "type": "string" }, "creation": { "minLength": 1, "type": "string" } } }, "format": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "context": { "required": [ "encounter", "event", "facilityType", "period", "practiceSetting", "related", "sourcePatientInfo" ], "type": "object", "properties": { "encounter": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "event": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "period": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "minLength": 1, "type": "string" }, "end": { "minLength": 1, "type": "string" } } }, "facilityType": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "practiceSetting": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "sourcePatientInfo": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "related": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "identifier": { "required": [ "system", "value" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } } } } } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Encounter": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter", "required": [ "class", "id", "meta", "resourceType", "status", "subject", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "status": { "minLength": 1, "type": "string" }, "class": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "subject": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Goal": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal", "required": [ "addresses", "category", "description", "expressedBy", "id", "identifier", "lifecycleStatus", "meta", "outcomeReference", "priority", "resourceType", "startDate", "statusDate", "statusReason", "subject", "target", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "description": "Business identifiers assigned to the goal by care management or source clinical systems.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier value for the goal when the issuing system is implementation-defined.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Business identifier value for the goal.", "minLength": 1, "type": "string" } } } }, "lifecycleStatus": { "minLength": 1, "type": "string" }, "category": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } } }, "priority": { "required": [ "coding", "text" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "text": { "minLength": 1, "type": "string" } } }, "description": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } }, "subject": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "startDate": { "minLength": 1, "type": "string" }, "target": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "dueDate" ], "type": "object", "properties": { "measure": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "detailRange": { "required": [ "high", "low" ], "type": "object", "properties": { "low": { "required": [ "code", "system", "unit", "value" ], "type": "object", "properties": { "value": { "type": "number" }, "unit": { "minLength": 1, "type": "string" }, "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } }, "high": { "required": [ "code", "system", "unit", "value" ], "type": "object", "properties": { "value": { "type": "number" }, "unit": { "minLength": 1, "type": "string" }, "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } }, "dueDate": { "minLength": 1, "type": "string" } } } }, "statusDate": { "minLength": 1, "type": "string" }, "statusReason": { "minLength": 1, "type": "string" }, "expressedBy": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "addresses": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display" ], "type": "object", "properties": { "display": { "minLength": 1, "type": "string" } } } }, "outcomeReference": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Immunization": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization", "required": [ "doseQuantity", "education", "encounter", "expirationDate", "fundingSource", "id", "identifier", "isSubpotent", "location", "lotNumber", "manufacturer", "meta", "note", "occurrenceDateTime", "patient", "performer", "primarySource", "programEligibility", "reasonCode", "resourceType", "route", "site", "status", "text", "vaccineCode" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "description": "Business identifiers assigned to the immunization event by immunization registries, EHRs, or source systems.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier with a namespace in `system` and a resource-specific value in `value`.", "required": [ "system", "value" ], "type": "object", "properties": { "system": { "description": "Namespace or URI that defines the identifier value.", "minLength": 1, "type": "string" }, "value": { "description": "Identifier value unique within the stated system.", "minLength": 1, "type": "string" } } } }, "status": { "minLength": 1, "type": "string" }, "vaccineCode": { "required": [ "coding", "text" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } }, "text": { "minLength": 1, "type": "string" } } }, "patient": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "encounter": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "occurrenceDateTime": { "minLength": 1, "type": "string" }, "primarySource": { "type": "boolean" }, "location": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "manufacturer": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "lotNumber": { "minLength": 1, "type": "string" }, "expirationDate": { "minLength": 1, "type": "string" }, "site": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "route": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "doseQuantity": { "required": [ "code", "system", "value" ], "type": "object", "properties": { "value": { "type": "number" }, "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } }, "performer": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "function": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "actor": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } } } }, "note": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "reasonCode": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } } }, "isSubpotent": { "type": "boolean" }, "education": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "documentType", "presentationDate", "publicationDate" ], "type": "object", "properties": { "documentType": { "minLength": 1, "type": "string" }, "publicationDate": { "minLength": 1, "type": "string" }, "presentationDate": { "minLength": 1, "type": "string" } } } }, "programEligibility": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } } }, "fundingSource": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Location": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location", "required": [ "address", "alias", "description", "endpoint", "id", "identifier", "managingOrganization", "meta", "mode", "name", "physicalType", "position", "resourceType", "status", "telecom", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "$ref": "#/components/schemas/Account_text" }, "identifier": { "description": "Business identifiers assigned to the location by scheduling, facility, or source systems.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/CarePlan_identifier" } }, "status": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "alias": { "type": "array", "items": { "properties": {} } }, "description": { "minLength": 1, "type": "string" }, "mode": { "minLength": 1, "type": "string" }, "telecom": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ActivityDefinition_telecom" } }, "address": { "$ref": "#/components/schemas/Location_address" }, "physicalType": { "$ref": "#/components/schemas/ActivityDefinition_valueCodeableConcept" }, "position": { "$ref": "#/components/schemas/Location_position" }, "managingOrganization": { "$ref": "#/components/schemas/Account_coverage" }, "endpoint": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Appointment_basedOn" } }, "meta": { "$ref": "#/components/schemas/Account_meta" } } }, "Location_address": { "required": [ "city", "country", "line", "postalCode", "use" ], "type": "object", "properties": { "use": { "minLength": 1, "type": "string" }, "line": { "type": "array", "items": { "properties": {} } }, "city": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "type": "string" }, "country": { "minLength": 1, "type": "string" } } }, "Location_position": { "required": [ "altitude", "latitude", "longitude" ], "type": "object", "properties": { "longitude": { "type": "number" }, "latitude": { "type": "number" }, "altitude": { "type": "number" } } }, "MedicationRequest": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest", "required": [ "id", "text", "identifier", "status", "intent", "medicationReference", "subject", "encounter", "authoredOn", "requester", "reasonCode", "dosageInstruction" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "description": "Business identifiers assigned to the medication request by the ordering or source clinical system.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier value for the medication request when the issuing system is implementation-defined.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Business identifier value for the medication request.", "minLength": 1, "type": "string" } } } }, "status": { "minLength": 1, "type": "string" }, "intent": { "minLength": 1, "type": "string" }, "medicationReference": { "required": [ "reference", "display" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "subject": { "required": [ "reference", "display" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "encounter": { "required": [ "reference", "display" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "authoredOn": { "minLength": 1, "type": "string" }, "requester": { "required": [ "reference", "display" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "reasonCode": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "dosageInstruction": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "sequence": { "minLength": 1, "type": "string" }, "text": { "minLength": 1, "type": "string" } } } } } }, "Observation": { "x-us-core-profiles": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height", "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus" ], "required": [ "category", "code", "effectiveDateTime", "encounter", "id", "meta", "resourceType", "status", "subject", "text", "valueQuantity" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "status": { "minLength": 1, "type": "string" }, "category": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "code": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "subject": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "encounter": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "effectiveDateTime": { "minLength": 1, "type": "string" }, "valueQuantity": { "required": [ "code", "system", "unit", "value" ], "type": "object", "properties": { "value": { "type": "number" }, "unit": { "minLength": 1, "type": "string" }, "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Organization": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization", "required": [ "address", "alias", "endpoint", "id", "meta", "name", "resourceType", "telecom", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "name": { "minLength": 1, "type": "string" }, "alias": { "type": "array", "items": { "type": "object", "properties": {} } }, "telecom": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "value" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } } } }, "address": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "city", "country", "postalCode", "state" ], "type": "object", "properties": { "line": { "type": "array", "items": { "type": "object", "properties": {} } }, "city": { "minLength": 1, "type": "string" }, "state": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "type": "string" }, "country": { "minLength": 1, "type": "string" } } } }, "endpoint": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Patient": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient", "required": [ "active", "contact", "gender", "id", "identifier", "link", "managingOrganization", "meta", "name", "photo", "resourceType", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "description": "Business identifiers assigned to the patient, such as an MRN, MPI, or enterprise patient identifier.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier with declared use, identifier system, and value for the patient.", "required": [ "system", "use", "value" ], "type": "object", "properties": { "use": { "description": "Purpose of the identifier, such as official, usual, temporary, secondary, or old.", "minLength": 1, "type": "string" }, "type": { "description": "Coded type describing what kind of patient identifier is being carried.", "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "description": "Code system that defines the identifier type.", "minLength": 1, "type": "string" }, "code": { "description": "Code for the identifier type.", "minLength": 1, "type": "string" } } } } } }, "system": { "description": "Namespace or URI that defines the patient identifier value.", "minLength": 1, "type": "string" }, "value": { "description": "Patient identifier value unique within the stated system.", "minLength": 1, "type": "string" } } } }, "active": { "type": "boolean" }, "name": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "family", "use" ], "type": "object", "properties": { "use": { "minLength": 1, "type": "string" }, "family": { "minLength": 1, "type": "string" }, "given": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "gender": { "minLength": 1, "type": "string" }, "photo": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "contentType", "data" ], "type": "object", "properties": { "contentType": { "minLength": 1, "type": "string" }, "data": { "minLength": 1, "type": "string" } } } }, "contact": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "relationship": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } } }, "organization": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "managingOrganization": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "link": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "type" ], "type": "object", "properties": { "other": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "type": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Practitioner": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "required": [ "active", "address", "id", "identifier", "meta", "name", "qualification", "resourceType", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "description": "Business identifiers assigned to the practitioner, such as an NPI or another provider identifier.", "minItems": 1, "uniqueItems": true, "type": "array", "items": { "description": "Identifier with a namespace in `system` and a practitioner-specific value in `value`.", "required": [ "system", "value" ], "type": "object", "properties": { "system": { "description": "Namespace or URI that defines the identifier value.", "minLength": 1, "type": "string" }, "value": { "description": "Identifier value unique within the stated system.", "minLength": 1, "type": "string" } } } }, "active": { "type": "boolean" }, "name": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "family" ], "type": "object", "properties": { "family": { "minLength": 1, "type": "string" }, "given": { "type": "array", "items": { "type": "object", "properties": {} } }, "prefix": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "address": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "city", "postalCode", "state", "use" ], "type": "object", "properties": { "use": { "minLength": 1, "type": "string" }, "line": { "type": "array", "items": { "type": "object", "properties": {} } }, "city": { "minLength": 1, "type": "string" }, "state": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "type": "string" } } } }, "qualification": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "identifier": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "value" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } } } }, "code": { "required": [ "coding", "text" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "text": { "minLength": 1, "type": "string" } } }, "period": { "required": [ "start" ], "type": "object", "properties": { "start": { "minLength": 1, "type": "string" } } }, "issuer": { "required": [ "display" ], "type": "object", "properties": { "display": { "minLength": 1, "type": "string" } } } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Procedure": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure", "required": [ "asserter", "code", "followUp", "id", "meta", "note", "performedDateTime", "performer", "reasonCode", "recorder", "resourceType", "status", "subject", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "status": { "minLength": 1, "type": "string" }, "code": { "required": [ "coding", "text" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "text": { "minLength": 1, "type": "string" } } }, "subject": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "performedDateTime": { "minLength": 1, "type": "string" }, "recorder": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "asserter": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "performer": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "actor": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "reasonCode": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "followUp": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "note": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "Provenance": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance", "required": [ "agent", "entity", "id", "location", "meta", "occurredPeriod", "policy", "reason", "recorded", "resourceType", "target", "text" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "target": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "occurredPeriod": { "required": [ "end", "start" ], "type": "object", "properties": { "start": { "minLength": 1, "type": "string" }, "end": { "minLength": 1, "type": "string" } } }, "recorded": { "minLength": 1, "type": "string" }, "policy": { "type": "array", "items": { "type": "object", "properties": {} } }, "location": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } }, "reason": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "agent": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string" }, "type": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "who": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } } } }, "entity": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "role" ], "type": "object", "properties": { "role": { "minLength": 1, "type": "string" }, "what": { "required": [ "display", "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "code", "display", "system" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } } }, "description": "" }, "MedicationDispense": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense", "description": "US Core MedicationDispense (new in US Core 6.1.0)", "required": [ "id", "resourceType", "status", "medicationCodeableConcept", "subject", "performer", "quantity", "whenHandedOver" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "status": { "minLength": 1, "type": "string" }, "medicationCodeableConcept": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "code" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "subject": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "performer": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "actor": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } } } }, "authorizingPrescription": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" } } } }, "quantity": { "required": [ "value", "unit" ], "type": "object", "properties": { "value": { "type": "number" }, "unit": { "minLength": 1, "type": "string" }, "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } }, "daysSupply": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number" }, "unit": { "minLength": 1, "type": "string" } } }, "whenHandedOver": { "minLength": 1, "type": "string" }, "dosageInstruction": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": null } } } } } }, "RelatedPerson": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson", "description": "US Core RelatedPerson (new in US Core 6.1.0)", "required": [ "id", "resourceType", "active", "patient", "relationship", "name" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "active": { "type": "boolean" }, "patient": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "relationship": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "coding": { "minItems": 1 }, "text": { "minLength": 1, "type": "string" } } } }, "name": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "family" ], "type": "object", "properties": { "use": { "minLength": 1, "type": "string" }, "family": { "minLength": 1, "type": "string" }, "given": { "type": "array" } } } }, "telecom": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "value" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } } } }, "address": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "use": { "minLength": 1, "type": "string" }, "line": { "type": "array" }, "city": { "minLength": 1, "type": "string" }, "state": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": null } } } } } }, "Coverage": { "x-us-core-profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage", "description": "US Core Coverage (new in US Core 6.1.0)", "required": [ "id", "resourceType", "status", "subscriberId", "beneficiary", "payor" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "identifier": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "value" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } } } }, "status": { "minLength": 1, "type": "string" }, "type": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "code" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } } } }, "subscriberId": { "minLength": 1, "type": "string" }, "beneficiary": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } }, "dependent": { "minLength": 1, "type": "string" }, "relationship": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "system", "code" ], "type": "object", "properties": { "system": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" } } } } } }, "period": { "type": "object", "properties": { "start": { "minLength": 1, "type": "string" }, "end": { "minLength": 1, "type": "string" } } }, "payor": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "minLength": 1, "type": "string" }, "display": { "minLength": 1, "type": "string" } } } }, "class": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "required": [ "coding" ], "type": "object", "properties": { "coding": { "minItems": 1 } } }, "value": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" } } } }, "meta": { "required": [ "tag" ], "type": "object", "properties": { "tag": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "required": null } } } } } }, "Error": { "required": [ "text", "issue" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string" }, "text": { "required": [ "div", "status" ], "type": "object", "properties": { "status": { "minLength": 1, "type": "string" }, "div": { "minLength": 1, "type": "string" } } }, "issue": { "type": "array", "items": { "required": [ "severity", "code", "diagnostics" ], "type": "object", "properties": { "severity": { "minLength": 1, "type": "string" }, "code": { "minLength": 1, "type": "string" }, "diagnostics": { "minLength": 1, "type": "string" } } } } } } }, "requestBodies": { "Location": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearerAuth": [] } ] }