{ "openapi": "3.0.1", "info": { "title": "R4 Fhir", "description": "Fast Healthcare Interoperability Resources (FHIR, pronounced 'Fire') defines a set of 'Resources' that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation.", "version": "v1" }, "servers": [ { "url": "https://fhir.nextgen.com/nge/prod/fhir-api-r4/fhir/R4" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/AllergyIntolerance/{id}": { "get": { "summary": "Gets the Allergy intolerance resource for given allergyId.", "description": "Fetches a single allergy/intolerance record by id. \n \n FHIR Resource: AllergyIntolerance \n *\tMedication Allergies \n *\tSubstance (Drug Class) \n *\tSubstance (Medication) \n *\tReaction", "tags": [ "AllergyIntolerance" ], "parameters": [ { "name": "id", "in": "path", "description": "allergyId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "AllergyIntolerance", "type": "object", "additionalProperties": false, "required": [ "id", "clinicalStatus", "verificationStatus", "criticality" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "clinicalStatus": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "verificationStatus": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "criticality": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/AllergyIntoleranceCriticality" }, "code": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "patient": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "onsetDateTime": { "type": "string", "format": "date-time" }, "recorder": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "reaction": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfReactionComponent" } }, "definitions": { "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "AllergyIntoleranceCriticality": { "type": "string", "description": "", "x-enumNames": [ "CRITL", "CRITH", "CRITU" ], "enum": [ "CRITL", "CRITH", "CRITU" ] }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfReactionComponent": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ReactionComponent" } }, "ReactionComponent": { "type": "object", "additionalProperties": false, "required": [ "severity" ], "properties": { "manifestation": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "severity": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/AllergyIntoleranceSeverity" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "AllergyIntoleranceSeverity": { "type": "string", "description": "", "x-enumNames": [ "Mild", "Moderate", "Severe" ], "enum": [ "Mild", "Moderate", "Severe" ] } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/AllergyIntolerance": { "get": { "summary": "Gets bundle of Allergy intolerance resource.", "description": "Fetches a bundled resource containing the allergy/intolerance records for the patient mentioned in the request. FHIR Resource: AllergyIntolerance \n *\tMedication Allergies \n *\tSubstance (Drug Class) \n *\tSubstance (Medication) \n *\tReaction", "tags": [ "AllergyIntolerance" ], "parameters": [ { "name": "_id", "in": "query", "description": "Allergy id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "Who the sensitivity is for.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "date", "in": "query", "description": "When allergy or intolerance was identified.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfAllergyIntolerance", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfAllergyIntolerance" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfAllergyIntolerance": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/EntryOfAllergyIntolerance" } }, "EntryOfAllergyIntolerance": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/AllergyIntolerance" } } }, "AllergyIntolerance": { "type": "object", "additionalProperties": false, "required": [ "id", "clinicalStatus", "verificationStatus", "criticality" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "clinicalStatus": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "verificationStatus": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "criticality": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/AllergyIntoleranceCriticality" }, "code": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "patient": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "onsetDateTime": { "type": "string", "format": "date-time" }, "recorder": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "reaction": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfReactionComponent" } } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "AllergyIntoleranceCriticality": { "type": "string", "description": "", "x-enumNames": [ "CRITL", "CRITH", "CRITU" ], "enum": [ "CRITL", "CRITH", "CRITU" ] }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfReactionComponent": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ReactionComponent" } }, "ReactionComponent": { "type": "object", "additionalProperties": false, "required": [ "severity" ], "properties": { "manifestation": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "severity": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/AllergyIntoleranceSeverity" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1AllergyIntolerance/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "AllergyIntoleranceSeverity": { "type": "string", "description": "", "x-enumNames": [ "Mild", "Moderate", "Severe" ], "enum": [ "Mild", "Moderate", "Severe" ] } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/CarePlan/{id}": { "get": { "summary": "Gets the Careplan resource for given carePlanId.", "description": "Fetches a single plan of treatment(care plans, orders) and assessment note by id. \n \n FHIR Resource: CarePlan \n *\tAssessment and Plan of Treatment \n", "tags": [ "CarePlan" ], "parameters": [ { "name": "id", "in": "path", "description": "carePlanId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "CarePlan", "type": "object", "additionalProperties": false, "required": [ "id", "status", "intent" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/CarePlanStatus" }, "intent": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/CarePlanIntent" }, "category": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "subject": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } }, "definitions": { "CarePlanStatus": { "type": "string", "description": "", "x-enumNames": [ "Proposed", "Draft", "Active", "Completed", "Cancelled" ], "enum": [ "Proposed", "Draft", "Active", "Completed", "Cancelled" ] }, "CarePlanIntent": { "type": "string", "description": "", "x-enumNames": [ "Proposal", "Plan", "Order", "Option" ], "enum": [ "Proposal", "Plan", "Order", "Option" ] }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/CarePlan": { "get": { "summary": "Gets bundle of Careplan resource.", "description": "Fetches a bundled resource containing plan of treatment(care plans, orders) and assessment notes for the patient mentioned in the request. \n \n FHIR Resource: CarePlan \n *\tAssessment and Plan of Treatment \n", "tags": [ "CarePlan" ], "parameters": [ { "name": "_id", "in": "query", "description": "CarePlan id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "Who the care plan is for.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "category", "in": "query", "description": "Type of plan.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "Careplan status", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfCarePlan", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfCarePlan" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfCarePlan": { "type": "array", "items": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/EntryOfCarePlan" } }, "EntryOfCarePlan": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/CarePlan" } } }, "CarePlan": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "intent" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/CarePlanStatus" }, "intent": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/CarePlanIntent" }, "category": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "subject": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } } }, "CarePlanStatus": { "type": "string", "description": "", "x-enumNames": [ "Proposed", "Draft", "Active", "Completed", "Cancelled" ], "enum": [ "Proposed", "Draft", "Active", "Completed", "Cancelled" ] }, "CarePlanIntent": { "type": "string", "description": "", "x-enumNames": [ "Proposal", "Plan", "Order", "Option" ], "enum": [ "Proposal", "Plan", "Order", "Option" ] }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1CarePlan/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/CareTeam/{id}": { "get": { "summary": "Gets CareTeamMember resource for given careTeamMemberId.", "description": "Fetches a single Care Team member by id. \n \n FHIR Resource: CareTeam \n *\tCare Team \n", "tags": [ "CareTeam" ], "parameters": [ { "name": "id", "in": "path", "description": "careTeamMemberId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "CareTeam", "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/CareTeamStatus" }, "subject": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "participant": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfCareTeamMemberParticipantComponent" } }, "definitions": { "CareTeamStatus": { "type": "string", "description": "", "x-enumNames": [ "Proposed", "Active", "Suspended", "Inactive", "EnteredInError" ], "enum": [ "Proposed", "Active", "Suspended", "Inactive", "EnteredInError" ] }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCareTeamMemberParticipantComponent": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/CareTeamMemberParticipantComponent" } }, "CareTeamMemberParticipantComponent": { "type": "object", "additionalProperties": false, "properties": { "role": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "member": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/CareTeam": { "get": { "summary": "Gets bundle of CareTeam resource.", "description": "Fetches a bundled resource containing details of the Care Team members for the patient mentioned in the request. \n \n FHIR Resource: CareTeam \n *\tCare Team \n", "tags": [ "CareTeam" ], "parameters": [ { "name": "_id", "in": "query", "description": "CareTeam id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "Who care team is for", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "status", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfCareTeam", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfCareTeam" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfCareTeam": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/EntryOfCareTeam" } }, "EntryOfCareTeam": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/CareTeam" } } }, "CareTeam": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/CareTeamStatus" }, "subject": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "participant": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfCareTeamMemberParticipantComponent" } } }, "CareTeamStatus": { "type": "string", "description": "", "x-enumNames": [ "Proposed", "Active", "Suspended", "Inactive", "EnteredInError" ], "enum": [ "Proposed", "Active", "Suspended", "Inactive", "EnteredInError" ] }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCareTeamMemberParticipantComponent": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/CareTeamMemberParticipantComponent" } }, "CareTeamMemberParticipantComponent": { "type": "object", "additionalProperties": false, "properties": { "role": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "member": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1CareTeam/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Condition/{id}": { "get": { "summary": "Gets Condition resource for given conditionId.", "description": "Fetches a Condition resource containing the condition/problem associated with the provided resource id. \n \n FHIR Resource: Condition \n *\tHealth Concerns \n * Problems \n * Encounter Diagnosis \n", "tags": [ "Condition" ], "parameters": [ { "name": "id", "in": "path", "description": "conditionId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Condition", "type": "object", "additionalProperties": false, "required": [ "id", "verificationStatus" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "clinicalStatus": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "verificationStatus": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "category": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "code": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "onset": { "type": "string", "format": "date-time" } }, "definitions": { "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Condition": { "get": { "summary": "Gets bundle of Condition resource.", "description": "Fetches a bundled resource containing the condition/problem associated with the provided resource id. \n \n FHIR Resource: Condition \n *\tHealth Concerns \n * Problems \n * Encounter Diagnosis \n", "tags": [ "Condition" ], "parameters": [ { "name": "_id", "in": "query", "description": "Condition id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "Who has the condition?", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "category", "in": "query", "description": "Condition category", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "onset-date", "in": "query", "description": "Date related onsets.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "clinical-status", "in": "query", "description": "status.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfCondition", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfCondition" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfCondition": { "type": "array", "items": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/EntryOfCondition" } }, "EntryOfCondition": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/Condition" } } }, "Condition": { "type": "object", "additionalProperties": false, "required": [ "id", "verificationStatus" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "clinicalStatus": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "verificationStatus": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "category": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "code": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "onset": { "type": "string", "format": "date-time" } } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Condition/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Device/{id}": { "get": { "summary": "Gets Device resource for given deviceId.", "description": "Fetches a single implantable device by id. \n \n FHIR Resource: Device \n *\tUnique Device Identifier(s) for Patients Implantable Device(s) \n", "tags": [ "Device" ], "parameters": [ { "name": "id", "in": "path", "description": "deviceId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Device", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "udiCarrier": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfUdiCarrierComponent" }, "type": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "patient": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } }, "definitions": { "ListOfUdiCarrierComponent": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/UdiCarrierComponent" } }, "UdiCarrierComponent": { "type": "object", "additionalProperties": false, "properties": { "deviceIdentifier": { "type": "string" }, "carrierHRF": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Device": { "get": { "summary": "Gets bundle of device resource.", "description": "Fetches a bundled resource containing all the implantable devices for the patient mentioned in the request. \n \n FHIR Resource: Device \n *\tUnique Device Identifier(s) for Patients Implantable Device(s) \n", "tags": [ "Device" ], "parameters": [ { "name": "_id", "in": "query", "description": "Device id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "Patient information, if the resource is affixed to a person.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "The availability status of the device.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfDevice", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfDevice" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfDevice": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/EntryOfDevice" } }, "EntryOfDevice": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/Device" } } }, "Device": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "udiCarrier": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfUdiCarrierComponent" }, "type": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "patient": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } } }, "ListOfUdiCarrierComponent": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/UdiCarrierComponent" } }, "UdiCarrierComponent": { "type": "object", "additionalProperties": false, "properties": { "deviceIdentifier": { "type": "string" }, "carrierHRF": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Device/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/DiagnosticReport/{id}": { "get": { "summary": "Gets Diagnostic report resource for given orderTestId.", "description": "Fetches a single lab, radiology, cardiology or pathology report by id. The observations and/or documents are contained in the resource. \n \n FHIR Resource for Report and Note Exchange: DiagnosticReport \n *\tRadiology Report \n *\tCardiology Report \n *\tPathology Report \n \n FHIR Resource for Lab Results Reporting: Observation, DiagnosticReport \n *\tTests \n *\tValues/Results \n", "tags": [ "DiagnosticReport" ], "parameters": [ { "name": "id", "in": "path", "description": "orderTestId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "DiagnosticReport", "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/DiagnosticReportStatusR4" }, "category": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "code": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "effectiveDateTime": { "type": "string", "format": "date-time" }, "issued": { "type": "string", "format": "date-time" }, "performer": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfResourceReference" }, "result": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfResourceReference" } }, "definitions": { "DiagnosticReportStatusR4": { "type": "string", "description": "", "x-enumNames": [ "Registered", "Partial", "Preliminary", "Final", "Amended", "Corrected", "Appended", "Cancelled", "EnteredInError", "Unknown" ], "enum": [ "Registered", "Partial", "Preliminary", "Final", "Amended", "Corrected", "Appended", "Cancelled", "EnteredInError", "Unknown" ] }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfResourceReference": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/DiagnosticReport": { "get": { "summary": "Gets bundle of DiagnosticReport resource.", "description": "Fetches a bundled resource containing all the lab, radiology, cardiology or pathology reports. The observations and/or documents are contained in the resource. \n \n FHIR Resource for Report and Note Exchange: DiagnosticReport \n *\tRadiology Report \n *\tCardiology Report \n *\tPathology Report \n \n FHIR Resource for Lab Results Reporting: Observation, DiagnosticReport \n *\tTests \n *\tValues/Results \n", "tags": [ "DiagnosticReport" ], "parameters": [ { "name": "_id", "in": "query", "description": "Diagnostic Report id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "patientId", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "category", "in": "query", "description": "A code that classifies the clinical discipline, department or diagnostic service that created the report.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "code", "in": "query", "description": "A code or name that describes this diagnostic report.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "date", "in": "query", "description": "Obtained date/time. If the obtained element is a period, a date that falls in the period", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfDiagnosticReport", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfDiagnosticReport" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfDiagnosticReport": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/EntryOfDiagnosticReport" } }, "EntryOfDiagnosticReport": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/DiagnosticReport" } } }, "DiagnosticReport": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/DiagnosticReportStatusR4" }, "category": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "code": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "effectiveDateTime": { "type": "string", "format": "date-time" }, "issued": { "type": "string", "format": "date-time" }, "performer": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfResourceReference" }, "result": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfResourceReference" } } }, "DiagnosticReportStatusR4": { "type": "string", "description": "", "x-enumNames": [ "Registered", "Partial", "Preliminary", "Final", "Amended", "Corrected", "Appended", "Cancelled", "EnteredInError", "Unknown" ], "enum": [ "Registered", "Partial", "Preliminary", "Final", "Amended", "Corrected", "Appended", "Cancelled", "EnteredInError", "Unknown" ] }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfResourceReference": { "type": "array", "items": { "$ref": "#/paths/~1DiagnosticReport/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/DocumentReference/{id}": { "get": { "summary": "Gets DocumentReference resource for given documentReferenceId.", "description": "Fetches a single Document Reference. A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. \n \n FHIR Resource: DocumentReference \n \n *\tConsultation Note \n *\tDischarge Summary Note \n *\tHistory & Physical Note \n *\tProcedures Note \n *\tProgress Note \n *\tImaging Narrative \n *\tLaboratory Report Narrative \n *\tPathology Report Narrative", "tags": [ "DocumentReference" ], "parameters": [ { "name": "id", "in": "path", "description": "documentReferenceId.", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "DocumentReference", "type": "object", "additionalProperties": false, "required": [ "id", "status", "content" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifiers": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "subject": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "type": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "category": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "author": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "date": { "type": "string", "format": "date-time" }, "custodian": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "status": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/DocumentReferenceStatus" }, "content": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfContent" } }, "definitions": { "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "DocumentReferenceStatus": { "type": "string", "description": "", "x-enumNames": [ "Current", "Superseded", "EnteredInError" ], "enum": [ "Current", "Superseded", "EnteredInError" ] }, "ListOfContent": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Content" } }, "Content": { "type": "object", "additionalProperties": false, "properties": { "attachment": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Attachment" } } }, "Attachment": { "type": "object", "additionalProperties": false, "properties": { "contentType": { "type": "string" }, "data": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/DocumentReference": { "get": { "summary": "Gets bundle of DocumentReference resource.", "description": "Fetches a bundled resource containing the valid Document References for the patient mentioned in the request. \n \n FHIR Resource: DocumentReference \n \n *\tConsultation Note \n *\tDischarge Summary Note \n *\tHistory & Physical Note \n *\tProcedures Note \n *\tProgress Note \n *\tImaging Narrative \n *\tLaboratory Report Narrative \n *\tPathology Report Narrative", "tags": [ "DocumentReference" ], "parameters": [ { "name": "_id", "in": "query", "description": "Document Reference id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "Who/what is the subject of the document.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "type", "in": "query", "description": "Specifies the particular kind of document referenced (LOINC Code).", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "date", "in": "query", "description": "When the document reference was created.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "category", "in": "query", "description": "A categorization for the type of document referenced.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfDocumentReference", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfDocumentReference" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfDocumentReference": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/EntryOfDocumentReference" } }, "EntryOfDocumentReference": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/DocumentReference" } } }, "DocumentReference": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "content" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifiers": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "subject": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "type": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "category": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "author": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "date": { "type": "string", "format": "date-time" }, "custodian": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "status": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/DocumentReferenceStatus" }, "content": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/ListOfContent" } } }, "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "DocumentReferenceStatus": { "type": "string", "description": "", "x-enumNames": [ "Current", "Superseded", "EnteredInError" ], "enum": [ "Current", "Superseded", "EnteredInError" ] }, "ListOfContent": { "type": "array", "items": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Content" } }, "Content": { "type": "object", "additionalProperties": false, "properties": { "attachment": { "$ref": "#/paths/~1DocumentReference/get/responses/200/content/application~1json/schema/definitions/Attachment" } } }, "Attachment": { "type": "object", "additionalProperties": false, "properties": { "contentType": { "type": "string" }, "data": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Encounter/{id}": { "get": { "summary": "Gets Encounter resource for given encounterId.", "description": "Fetches a single Encounter. An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. \n \n FHIR Resource: Encounter \n *\tEncounters \n \n FHIR Resource: Location \n * Location \n", "tags": [ "Encounter" ], "parameters": [ { "name": "id", "in": "path", "description": "encounterId.", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Encounter", "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifiers": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "status": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/EncounterStatus" }, "class": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Coding" }, "type": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "subject": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "participants": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfParticipantComponent" }, "period": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Period" } }, "definitions": { "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "EncounterStatus": { "type": "string", "description": "", "x-enumNames": [ "Planned", "Arrived", "Triaged", "InProgress", "Onleave", "Finished", "Cancelled", "EnteredInError", "Unknown" ], "enum": [ "Planned", "Arrived", "Triaged", "InProgress", "Onleave", "Finished", "Cancelled", "EnteredInError", "Unknown" ] }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfParticipantComponent": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ParticipantComponent" } }, "ParticipantComponent": { "type": "object", "additionalProperties": false, "properties": { "individual": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "type": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "period": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Period" } } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Encounter": { "get": { "summary": "Gets bundle of Encounter resource.", "description": "Fetches a bundled resource containing the valid encounters for the patient mentioned in the request. \n \n FHIR Resource: Encounter \n *\tEncounters \n \n FHIR Resource: Location \n * Location \n", "tags": [ "Encounter" ], "parameters": [ { "name": "_id", "in": "query", "description": "Encounter id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "The patient or group present at the encounter.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "date", "in": "query", "description": "A date within the period the encounter lasted.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfEncounter", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfEncounter" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfEncounter": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/EntryOfEncounter" } }, "EntryOfEncounter": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Encounter" } } }, "Encounter": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifiers": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "status": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/EncounterStatus" }, "class": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Coding" }, "type": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "subject": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "participants": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfParticipantComponent" }, "period": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Period" } } }, "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "EncounterStatus": { "type": "string", "description": "", "x-enumNames": [ "Planned", "Arrived", "Triaged", "InProgress", "Onleave", "Finished", "Cancelled", "EnteredInError", "Unknown" ], "enum": [ "Planned", "Arrived", "Triaged", "InProgress", "Onleave", "Finished", "Cancelled", "EnteredInError", "Unknown" ] }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfParticipantComponent": { "type": "array", "items": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ParticipantComponent" } }, "ParticipantComponent": { "type": "object", "additionalProperties": false, "properties": { "individual": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "type": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "period": { "$ref": "#/paths/~1Encounter/get/responses/200/content/application~1json/schema/definitions/Period" } } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Goal/{id}": { "get": { "summary": "Gets Goal resource for given goalId.", "description": "Fetches a single Goal by id. \n \n FHIR Resource: Goal \n *\tPatient Goals", "tags": [ "Goal" ], "parameters": [ { "name": "id", "in": "path", "description": "goalId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Goal", "type": "object", "additionalProperties": false, "required": [ "id", "lifecycleStatus" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "lifecycleStatus": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/GoalLifecycleStatus" }, "description": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "start": { "type": "string", "format": "date-time" }, "target": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ListOfTargetComponent" } }, "definitions": { "GoalLifecycleStatus": { "type": "string", "description": "", "x-enumNames": [ "Proposed", "Planned", "Accepted", "Active", "OnHold", "Completed", "Cancelled", "EnteredInError", "Rejected" ], "enum": [ "Proposed", "Planned", "Accepted", "Active", "OnHold", "Completed", "Cancelled", "EnteredInError", "Rejected" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfTargetComponent": { "type": "array", "items": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/TargetComponent" } }, "TargetComponent": { "type": "object", "additionalProperties": false, "properties": { "due": { "type": "string", "format": "date-time" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Goal": { "get": { "summary": "Gets bundle of Goal resource.", "description": "Fetches a bundled resource containing the health concern goals for the patient mentioned in the request.\n \n FHIR Resource: Goal \n *\tPatient Goals", "tags": [ "Goal" ], "parameters": [ { "name": "_id", "in": "query", "description": "Goal id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "Who this goal is intended for?", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "target-date", "in": "query", "description": "Reach goal on or before.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "lifecycle-status", "in": "query", "description": "State of the goal throughout its lifecycle.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfGoal", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfGoal" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfGoal": { "type": "array", "items": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/EntryOfGoal" } }, "EntryOfGoal": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/Goal" } } }, "Goal": { "type": "object", "additionalProperties": false, "required": [ "id", "lifecycleStatus" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "lifecycleStatus": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/GoalLifecycleStatus" }, "description": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "start": { "type": "string", "format": "date-time" }, "target": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ListOfTargetComponent" } } }, "GoalLifecycleStatus": { "type": "string", "description": "", "x-enumNames": [ "Proposed", "Planned", "Accepted", "Active", "OnHold", "Completed", "Cancelled", "EnteredInError", "Rejected" ], "enum": [ "Proposed", "Planned", "Accepted", "Active", "OnHold", "Completed", "Cancelled", "EnteredInError", "Rejected" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfTargetComponent": { "type": "array", "items": { "$ref": "#/paths/~1Goal/get/responses/200/content/application~1json/schema/definitions/TargetComponent" } }, "TargetComponent": { "type": "object", "additionalProperties": false, "properties": { "due": { "type": "string", "format": "date-time" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Immunization/{id}": { "get": { "summary": "Gets Immunization resource for given immunizationId.", "description": "Fetches a single immunization record by id. \n \n FHIR Resource: Immunization \n *\tImmunization", "tags": [ "Immunization" ], "parameters": [ { "name": "id", "in": "path", "description": "immunizationId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Immunization", "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ImmunizationStatusCodes" }, "statusReason": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "vaccineCode": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "patient": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "occurrenceDateTime": { "type": "string", "format": "date-time" }, "primarySource": { "type": "boolean" } }, "definitions": { "ImmunizationStatusCodes": { "type": "string", "description": "", "x-enumNames": [ "Completed", "EnteredInError", "NotDone" ], "enum": [ "Completed", "EnteredInError", "NotDone" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Immunization": { "get": { "summary": "Gets Bundle of Immunization Resource", "description": "Fetches a bundled resource containing the immunization records for the patient mentioned in the request. \n \n FHIR Resource: Immunization \n *\tImmunization", "tags": [ "Immunization" ], "parameters": [ { "name": "_id", "in": "query", "description": "Immunization id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "The patient for the vaccination record", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "date", "in": "query", "description": "Vaccination (non)-Administration Date.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "Immunization event status", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfImmunization", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfImmunization" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfImmunization": { "type": "array", "items": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/EntryOfImmunization" } }, "EntryOfImmunization": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/Immunization" } } }, "Immunization": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ImmunizationStatusCodes" }, "statusReason": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "vaccineCode": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "patient": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "occurrenceDateTime": { "type": "string", "format": "date-time" }, "primarySource": { "type": "boolean" } } }, "ImmunizationStatusCodes": { "type": "string", "description": "", "x-enumNames": [ "Completed", "EnteredInError", "NotDone" ], "enum": [ "Completed", "EnteredInError", "NotDone" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Immunization/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Location/{id}": { "get": { "summary": "Gets location resource", "description": "Fetches Location by id. Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. \n \n FHIR Resource: Location \n *\tLocation \n", "tags": [ "Location" ], "parameters": [ { "name": "id", "in": "path", "description": "LocationId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Location", "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "boolean" }, "name": { "type": "string" }, "telcom": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" }, "address": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/Address" } }, "definitions": { "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] }, "Address": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "line": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ListOfLine" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "period": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/Period" }, "use": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/AddressUse" } } }, "ListOfLine": { "type": "array", "items": { "type": "string" } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "AddressUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Billing" ], "enum": [ "Home", "Work", "Temp", "Old", "Billing" ] } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Location": { "get": { "summary": "Gets location bundle response", "description": "Fetches Bundled resource of locations. Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. \n \n FHIR Resource: Location \n *\tLocation \n", "tags": [ "Location" ], "parameters": [ { "name": "_id", "in": "query", "description": "Device id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "name", "in": "query", "description": "Location name", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address", "in": "query", "description": "Address of the location", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-city", "in": "query", "description": "A city specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-state", "in": "query", "description": "A state specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-postalcode", "in": "query", "description": "A postal code specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfLocation", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfLocation" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfLocation": { "type": "array", "items": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/EntryOfLocation" } }, "EntryOfLocation": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/Location" } } }, "Location": { "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "boolean" }, "name": { "type": "string" }, "telcom": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" }, "address": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/Address" } } }, "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] }, "Address": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "line": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/ListOfLine" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "period": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/Period" }, "use": { "$ref": "#/paths/~1Location/get/responses/200/content/application~1json/schema/definitions/AddressUse" } } }, "ListOfLine": { "type": "array", "items": { "type": "string" } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "AddressUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Billing" ], "enum": [ "Home", "Work", "Temp", "Old", "Billing" ] } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/MedicationRequest/{id}": { "get": { "summary": "Gets Medication request resource for given medicationRequestId.", "description": "Fetches a single medication prescription record by id. Medications are mapped to RxNorm codes. \n \n FHIR Resource: MedicationRequest \n *\tMedications", "tags": [ "MedicationRequest" ], "parameters": [ { "name": "id", "in": "path", "description": "medicationRequestId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "MedicationRequest", "type": "object", "additionalProperties": false, "required": [ "id", "status", "intent" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/MedicationrequestStatus" }, "intent": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/MedicationrequestStatus" }, "medicationCodeableConcept": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "authoredOn": { "type": "string", "format": "date-time" }, "requester": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "dosageInstruction": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "definitions": { "MedicationrequestStatus": { "type": "string", "description": "", "x-enumNames": [ "Active", "OnHold", "Cancelled", "Completed", "EnteredInError", "Stopped", "Draft", "Unknown" ], "enum": [ "Active", "OnHold", "Cancelled", "Completed", "EnteredInError", "Stopped", "Draft", "Unknown" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/MedicationRequest": { "get": { "summary": "Gets bundle of Medication request resource.", "description": "Fetches a bundled resource containing all the medication prescription records for the patient mentioned in the request. Medications are mapped to RxNorm codes. \n \n FHIR Resource: MedicationRequest \n *\tMedications", "tags": [ "MedicationRequest" ], "parameters": [ { "name": "_id", "in": "query", "description": "MedicationRequest id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "The identity of a patient to list orders for.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "Status of the prescription", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "intent", "in": "query", "description": "intent code", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "authoredon", "in": "query", "description": "date on which a prescription was written", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfMedicationRequest", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfMedicationRequest" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfMedicationRequest": { "type": "array", "items": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/EntryOfMedicationRequest" } }, "EntryOfMedicationRequest": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/MedicationRequest" } } }, "MedicationRequest": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "intent" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/MedicationrequestStatus" }, "intent": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/MedicationrequestStatus" }, "medicationCodeableConcept": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "authoredOn": { "type": "string", "format": "date-time" }, "requester": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "dosageInstruction": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } } }, "MedicationrequestStatus": { "type": "string", "description": "", "x-enumNames": [ "Active", "OnHold", "Cancelled", "Completed", "EnteredInError", "Stopped", "Draft", "Unknown" ], "enum": [ "Active", "OnHold", "Cancelled", "Completed", "EnteredInError", "Stopped", "Draft", "Unknown" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1MedicationRequest/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/MedicationStatement/{id}": { "get": { "summary": "Gets Medication Statement resource for given medicationStatementId.", "description": "Fetches a single medication statement record by id. \n \n FHIR Resource: MedicationStatement", "tags": [ "MedicationStatement" ], "parameters": [ { "name": "id", "in": "path", "description": "medicationStatementId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "MedicationStatement", "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/MedicationStatementStatus" }, "medicationCodeableConcept": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "effectivePeriod": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/Period" }, "dateAsserted": { "type": "string", "format": "date-time" }, "derivedFrom": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfResourceReference" }, "dosage": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfDosageComponent" } }, "definitions": { "MedicationStatementStatus": { "type": "string", "description": "", "x-enumNames": [ "Active", "Completed", "EnteredInError", "Intended" ], "enum": [ "Active", "Completed", "EnteredInError", "Intended" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "ListOfResourceReference": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } }, "ListOfDosageComponent": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/DosageComponent" } }, "DosageComponent": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/MedicationStatement": { "get": { "summary": "Gets bundle of Medication statement resource.", "description": "Fetches a bundled resource of medication statement records. \n \n FHIR Resource: MedicationStatement", "tags": [ "MedicationStatement" ], "parameters": [ { "name": "_id", "in": "query", "description": "MedicationStatement id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "patientId", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "status", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfMedicationStatement", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfMedicationStatement" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfMedicationStatement": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/EntryOfMedicationStatement" } }, "EntryOfMedicationStatement": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/MedicationStatement" } } }, "MedicationStatement": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/MedicationStatementStatus" }, "medicationCodeableConcept": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "effectivePeriod": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/Period" }, "dateAsserted": { "type": "string", "format": "date-time" }, "derivedFrom": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfResourceReference" }, "dosage": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfDosageComponent" } } }, "MedicationStatementStatus": { "type": "string", "description": "", "x-enumNames": [ "Active", "Completed", "EnteredInError", "Intended" ], "enum": [ "Active", "Completed", "EnteredInError", "Intended" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "ListOfResourceReference": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/ResourceReference" } }, "ListOfDosageComponent": { "type": "array", "items": { "$ref": "#/paths/~1MedicationStatement/get/responses/200/content/application~1json/schema/definitions/DosageComponent" } }, "DosageComponent": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Observation/{id}": { "get": { "summary": "Gets Observation resource for given observationId.", "description": "Fetches a single observation by id. \n \n FHIR Resource: Observation \n *\tDiastolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile) \n *\tSystolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile) \n *\tBody Height - Body height (FHIR Core Profile) \n *\tBody Weight - Body weight (FHIR Core Profile) \n *\tHeart Rate - Heart rate (FHIR Core Profile) \n *\tRespiratory Rate - Body temperature (FHIR Core Profile) \n *\tBody Temperature - Body temperature (FHIR Core Profile) \n *\tPulse Oximetry - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile) \n *\tInhaled Oxygen Concentration - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile) \n *\tBMI Percentile (2-20 years old) - US Core Pediatric BMI for Age Observation Profile (Builds on FHIR Core Profile) \n *\tWeight-for-Length Percentile (Birth-36 months) - US Core Pediatric Weight for Height Observation Profile (Builds on FHIR Core Profile) \n *\tOccipital-frontal Head Circumference Percentile (Birth-36 months) - US Core Pediatric Head Occipital Frontal Circumference Observation Profile (Builds on FHIR Core Profile) \n * Smoking Status", "tags": [ "Observation" ], "parameters": [ { "name": "id", "in": "path", "description": "observationId for laboratory, vital-signs or social-history.", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Observation", "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ObservationStatus" }, "category": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "code": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "effectiveDateTime": { "type": "string", "format": "date-time" }, "component": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfObservationComponent" }, "valueCodeableConcept": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "definitions": { "ObservationStatus": { "type": "string", "description": "", "x-enumNames": [ "Registered", "Preliminary", "Final", "Amended", "Cancelled", "EnteredInError", "Unknown" ], "enum": [ "Registered", "Preliminary", "Final", "Amended", "Cancelled", "EnteredInError", "Unknown" ] }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfObservationComponent": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ObservationComponent" } }, "ObservationComponent": { "type": "object", "additionalProperties": false, "properties": { "code": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "valueString": { "type": "string" }, "valueQuantity": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/Quantity" }, "referenceRange": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfReferenceRange" }, "dataAbsentReason": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } } }, "Quantity": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "number", "format": "decimal" }, "unit": { "type": "string" }, "system": { "type": "string" } } }, "ListOfReferenceRange": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ReferenceRange" } }, "ReferenceRange": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string" }, "low": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/SimpleQuantity" }, "high": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/SimpleQuantity" } } }, "SimpleQuantity": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string" }, "unit": { "type": "string" }, "system": { "type": "string" }, "code": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Observation": { "get": { "summary": "Gets bundle of Observation resource.", "description": "Fetches a bundled resource containing the observations. for the patient mentioned in the request. \n \n FHIR Resource: Observation \n *\tDiastolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile) \n *\tSystolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile) \n *\tBody Height - Body height (FHIR Core Profile) \n *\tBody Weight - Body weight (FHIR Core Profile) \n *\tHeart Rate - Heart rate (FHIR Core Profile) \n *\tRespiratory Rate - Body temperature (FHIR Core Profile) \n *\tBody Temperature - Body temperature (FHIR Core Profile) \n *\tPulse Oximetry - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile) \n *\tInhaled Oxygen Concentration - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile) \n *\tBMI Percentile (2-20 years old) - US Core Pediatric BMI for Age Observation Profile (Builds on FHIR Core Profile) \n *\tWeight-for-Length Percentile (Birth-36 months) - US Core Pediatric Weight for Height Observation Profile (Builds on FHIR Core Profile) \n *\tOccipital-frontal Head Circumference Percentile (Birth-36 months) - US Core Pediatric Head Occipital Frontal Circumference Observation Profile (Builds on FHIR Core Profile) \n * Smoking Status", "tags": [ "Observation" ], "parameters": [ { "name": "_id", "in": "query", "description": "Observation id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "patientId", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "category", "in": "query", "description": "The classification of the type of observation laboratory, vital-signs or social-history.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "code", "in": "query", "description": "The code of the observation type.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "date", "in": "query", "description": "Obtained date/time. If the obtained element is a period, a date that falls in the period", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "Codes providing the status of an observation", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfObservation", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfObservation" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfObservation": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/EntryOfObservation" } }, "EntryOfObservation": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/Observation" } } }, "Observation": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ObservationStatus" }, "category": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "code": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "effectiveDateTime": { "type": "string", "format": "date-time" }, "component": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfObservationComponent" }, "valueCodeableConcept": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } } }, "ObservationStatus": { "type": "string", "description": "", "x-enumNames": [ "Registered", "Preliminary", "Final", "Amended", "Cancelled", "EnteredInError", "Unknown" ], "enum": [ "Registered", "Preliminary", "Final", "Amended", "Cancelled", "EnteredInError", "Unknown" ] }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfObservationComponent": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ObservationComponent" } }, "ObservationComponent": { "type": "object", "additionalProperties": false, "properties": { "code": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "valueString": { "type": "string" }, "valueQuantity": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/Quantity" }, "referenceRange": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ListOfReferenceRange" }, "dataAbsentReason": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } } }, "Quantity": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "number", "format": "decimal" }, "unit": { "type": "string" }, "system": { "type": "string" } } }, "ListOfReferenceRange": { "type": "array", "items": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/ReferenceRange" } }, "ReferenceRange": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string" }, "low": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/SimpleQuantity" }, "high": { "$ref": "#/paths/~1Observation/get/responses/200/content/application~1json/schema/definitions/SimpleQuantity" } } }, "SimpleQuantity": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string" }, "unit": { "type": "string" }, "system": { "type": "string" }, "code": { "type": "string" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Organization/{id}": { "get": { "summary": "Gets Organization resource for given organizationId.", "description": "Fetches an Organization by id. Organization is a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. \n \n FHIR Resource: Organization \n *\tOrganization", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "description": "organizationId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Organization", "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "telcom": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" }, "address": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfAddress" } }, "definitions": { "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] }, "ListOfAddress": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Address" } }, "Address": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "line": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfLine" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "period": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Period" }, "use": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/AddressUse" } } }, "ListOfLine": { "type": "array", "items": { "type": "string" } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "AddressUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Billing" ], "enum": [ "Home", "Work", "Temp", "Old", "Billing" ] } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Organization": { "get": { "summary": "Gets bundle of Organization resource.", "description": "Fetches a Bundled resource of Organizations. Organization is a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. \n \n FHIR Resource: Organization \n *\tOrganization", "tags": [ "Organization" ], "parameters": [ { "name": "_id", "in": "query", "description": "Organization id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "name", "in": "query", "description": "A portion of the organization's name or alias.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address", "in": "query", "description": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-city", "in": "query", "description": "A city specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-postalcode", "in": "query", "description": "A postal code specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-state", "in": "query", "description": "A state specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-country", "in": "query", "description": "A country specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfOrganization", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfOrganization" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfOrganization": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/EntryOfOrganization" } }, "EntryOfOrganization": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Organization" } } }, "Organization": { "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "telcom": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" }, "address": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfAddress" } } }, "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] }, "ListOfAddress": { "type": "array", "items": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Address" } }, "Address": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "line": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/ListOfLine" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "period": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/Period" }, "use": { "$ref": "#/paths/~1Organization/get/responses/200/content/application~1json/schema/definitions/AddressUse" } } }, "ListOfLine": { "type": "array", "items": { "type": "string" } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "AddressUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Billing" ], "enum": [ "Home", "Work", "Temp", "Old", "Billing" ] } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Patient/{id}": { "get": { "summary": "Gets Patient resource for given patientId.", "description": "Fetches a single Patient by patient Id \n \n FHIR Resource: Patient.name.given \n * First Name \n *\tMiddle Name \n \n FHIR Resource: Patient.name.family \n *\tLast Name \n \n FHIR Resource: Patient.name \n *\tPrevious Name \n \n FHIR Resource: Patient.name.suffix \n *\tSuffix \n \n FHIR Resource: US Core Birth Sex Extension \n *\tBirth Sex \n \n FHIR Resource: Patient.birthDate \n *\tDate of Birth \n \n FHIR Resource: US Core Race Extension \n *\tRace \n \n FHIR Resource: US Core Ethnicity Extension \n *\tEthnicity \n \n FHIR Resource: Patient.communication \n *\tPreferred Language \n \n FHIR Resource: Patient.address \n *\tAddress \n \n FHIR Resource: Patient.telecom \n *\tPhone Number", "tags": [ "Patient" ], "parameters": [ { "name": "id", "in": "path", "description": "patientId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Patient", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "active": { "type": "boolean" }, "identifier": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifierDetail" }, "telcom": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" }, "name": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfHumanName" }, "address": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfAddress" }, "birthDate": { "type": "string", "format": "date-time" }, "extension": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfExtension" }, "communication": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfCommunicationComponent" } }, "definitions": { "ListOfIdentifierDetail": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/IdentifierDetail" } }, "IdentifierDetail": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "use": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/IdentifierUse" }, "type": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "System": { "type": "string" }, "Value": { "type": "string" } } }, "IdentifierUse": { "type": "string", "description": "", "x-enumNames": [ "Usual", "Official", "Temp", "Secondary" ], "enum": [ "Usual", "Official", "Temp", "Secondary" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] }, "ListOfHumanName": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/HumanName" } }, "HumanName": { "type": "object", "additionalProperties": false, "properties": { "use": { "type": "string" }, "text": { "type": "string" }, "family": { "type": "string" }, "given": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfGivenName" }, "givenElement": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfGivenElement" } } }, "ListOfGivenName": { "type": "array", "items": { "type": "string" } }, "ListOfGivenElement": { "type": "array", "items": { "type": "string" } }, "ListOfAddress": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Address" } }, "Address": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "line": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfLine" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "period": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Period" }, "use": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/AddressUse" } } }, "ListOfLine": { "type": "array", "items": { "type": "string" } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "AddressUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Billing" ], "enum": [ "Home", "Work", "Temp", "Old", "Billing" ] }, "ListOfExtension": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Extension" } }, "Extension": { "type": "object", "additionalProperties": false, "required": [ "url", "value" ], "properties": { "url": { "type": "string" }, "value": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" } } }, "ListOfCommunicationComponent": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/CommunicationComponent" } }, "CommunicationComponent": { "type": "object", "additionalProperties": false, "required": [ "value" ], "properties": { "value": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Patient": { "get": { "summary": "Gets bundle of Patient resource.", "description": "Fetches a bundled resource containing the valid patients mentioned in the request parameters. \n \n FHIR Resource: Patient.name.given \n * First Name \n *\tMiddle Name \n \n FHIR Resource: Patient.name.family \n *\tLast Name \n \n FHIR Resource: Patient.name \n *\tPrevious Name \n \n FHIR Resource: Patient.name.suffix \n *\tSuffix \n \n FHIR Resource: US Core Birth Sex Extension \n *\tBirth Sex \n \n FHIR Resource: Patient.birthDate \n *\tDate of Birth \n \n FHIR Resource: US Core Race Extension \n *\tRace \n \n FHIR Resource: US Core Ethnicity Extension \n *\tEthnicity \n \n FHIR Resource: Patient.communication \n *\tPreferred Language \n \n FHIR Resource: Patient.address \n *\tAddress \n \n FHIR Resource: Patient.telecom \n *\tPhone Number", "tags": [ "Patient" ], "parameters": [ { "name": "_id", "in": "query", "description": "Patient id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "identifier", "in": "query", "description": "identifier.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "name", "in": "query", "description": "Patient Name.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "given", "in": "query", "description": "A portion of the given name of the patient.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "family", "in": "query", "description": "A portion of the family name of the patient.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "gender", "in": "query", "description": "Gender of the patient", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address", "in": "query", "description": "A server defined search that may match any of the string in the Address line1.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-city", "in": "query", "description": "A city specified in an address", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "address-postalcode", "in": "query", "description": "A postalCode specified in an address.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "birthdate", "in": "query", "description": "The patient's date of birth.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "description": "Next page number for search results", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfPatient", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfPatient" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfPatient": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/EntryOfPatient" } }, "EntryOfPatient": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Patient" } } }, "Patient": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "active": { "type": "boolean" }, "identifier": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifierDetail" }, "telcom": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" }, "name": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfHumanName" }, "address": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfAddress" }, "birthDate": { "type": "string", "format": "date-time" }, "extension": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfExtension" }, "communication": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfCommunicationComponent" } } }, "ListOfIdentifierDetail": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/IdentifierDetail" } }, "IdentifierDetail": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "use": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/IdentifierUse" }, "type": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "System": { "type": "string" }, "Value": { "type": "string" } } }, "IdentifierUse": { "type": "string", "description": "", "x-enumNames": [ "Usual", "Official", "Temp", "Secondary" ], "enum": [ "Usual", "Official", "Temp", "Secondary" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] }, "ListOfHumanName": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/HumanName" } }, "HumanName": { "type": "object", "additionalProperties": false, "properties": { "use": { "type": "string" }, "text": { "type": "string" }, "family": { "type": "string" }, "given": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfGivenName" }, "givenElement": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfGivenElement" } } }, "ListOfGivenName": { "type": "array", "items": { "type": "string" } }, "ListOfGivenElement": { "type": "array", "items": { "type": "string" } }, "ListOfAddress": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Address" } }, "Address": { "type": "object", "additionalProperties": false, "required": [ "use" ], "properties": { "line": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfLine" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "period": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Period" }, "use": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/AddressUse" } } }, "ListOfLine": { "type": "array", "items": { "type": "string" } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "AddressUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Billing" ], "enum": [ "Home", "Work", "Temp", "Old", "Billing" ] }, "ListOfExtension": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/Extension" } }, "Extension": { "type": "object", "additionalProperties": false, "required": [ "url", "value" ], "properties": { "url": { "type": "string" }, "value": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" } } }, "ListOfCommunicationComponent": { "type": "array", "items": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/CommunicationComponent" } }, "CommunicationComponent": { "type": "object", "additionalProperties": false, "required": [ "value" ], "properties": { "value": { "$ref": "#/paths/~1Patient/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Practitioner/{id}": { "get": { "summary": "Gets Practitioner resource for given practitionerId.", "description": "Fetches a Practitioner by id. Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare. \n \n FHIR Resource: Practitioner \n *\tPractitioner", "tags": [ "Practitioner" ], "parameters": [ { "name": "id", "in": "path", "description": "practitionerId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Practitioner", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "name": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/HumanName" }, "telcom": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" } }, "definitions": { "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "HumanName": { "type": "object", "additionalProperties": false, "properties": { "use": { "type": "string" }, "text": { "type": "string" }, "family": { "type": "string" }, "given": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfGivenName" }, "givenElement": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfGivenElement" } } }, "ListOfGivenName": { "type": "array", "items": { "type": "string" } }, "ListOfGivenElement": { "type": "array", "items": { "type": "string" } }, "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Practitioner": { "get": { "summary": "Gets bundle of Practitioner resource.", "description": "Fetches a bundled resource of Practitioners. Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare. \n \n FHIR Resource: Practitioner \n *\tPractitioner", "tags": [ "Practitioner" ], "parameters": [ { "name": "_id", "in": "query", "description": "Practitioner id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "name", "in": "query", "description": "A server defined search that may match any of the string fields in the HumanName, including firstName,lastName,middleName", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "identifier", "in": "query", "description": "A practitioner's Identifier.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfPractitioner", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfPractitioner" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfPractitioner": { "type": "array", "items": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/EntryOfPractitioner" } }, "EntryOfPractitioner": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/Practitioner" } } }, "Practitioner": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfIdentifiers" }, "name": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/HumanName" }, "telcom": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfContactPoint" } } }, "ListOfIdentifiers": { "type": "array", "items": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/Identifier" } }, "Identifier": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "value": { "type": "string" } } }, "HumanName": { "type": "object", "additionalProperties": false, "properties": { "use": { "type": "string" }, "text": { "type": "string" }, "family": { "type": "string" }, "given": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfGivenName" }, "givenElement": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ListOfGivenElement" } } }, "ListOfGivenName": { "type": "array", "items": { "type": "string" } }, "ListOfGivenElement": { "type": "array", "items": { "type": "string" } }, "ListOfContactPoint": { "type": "array", "items": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ContactPoint" } }, "ContactPoint": { "type": "object", "additionalProperties": false, "required": [ "system", "use" ], "properties": { "system": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ContactPointSystem" }, "use": { "$ref": "#/paths/~1Practitioner/get/responses/200/content/application~1json/schema/definitions/ContactPointUse" }, "value": { "type": "string" } } }, "ContactPointSystem": { "type": "string", "description": "", "x-enumNames": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ], "enum": [ "Phone", "Fax", "Email", "Pager", "Url", "Sms", "Other" ] }, "ContactPointUse": { "type": "string", "description": "", "x-enumNames": [ "Home", "Work", "Temp", "Old", "Mobile" ], "enum": [ "Home", "Work", "Temp", "Old", "Mobile" ] } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Procedure/{id}": { "get": { "summary": "Gets Procedure resource for given procedureId.", "description": "Fetches a single Procedure by id. \n \n FHIR Resource: Procedure \n *\tProcedures", "tags": [ "Procedure" ], "parameters": [ { "name": "id", "in": "path", "description": "procedureId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "Procedure", "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ProcedureStatus" }, "code": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "performedDateTime": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/Period" } }, "definitions": { "ProcedureStatus": { "type": "string", "description": "", "x-enumNames": [ "InProgress", "Aborted", "Completed", "EnteredInError" ], "enum": [ "InProgress", "Aborted", "Completed", "EnteredInError" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Procedure": { "get": { "summary": "Gets bundle of Procedure resource.", "description": "Fetches a bundled resource containing the valid procedures for the patient mentioned in the request. The procedures pertain to the encounters available for the patient. \n \n FHIR Resource: Procedure \n *\tProcedures", "tags": [ "Procedure" ], "parameters": [ { "name": "_id", "in": "query", "description": "Procedure id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "patientId", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "date", "in": "query", "description": "When the procedure was performed.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "description": "A code specifying the state of the procedure.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "_revinclude", "in": "query", "description": "To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfProcedure", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfProcedure" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfProcedure": { "type": "array", "items": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/EntryOfProcedure" } }, "EntryOfProcedure": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/Procedure" } } }, "Procedure": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "status": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ProcedureStatus" }, "code": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" }, "subject": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "performedDateTime": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/Period" } } }, "ProcedureStatus": { "type": "string", "description": "", "x-enumNames": [ "InProgress", "Aborted", "Completed", "EnteredInError" ], "enum": [ "InProgress", "Aborted", "Completed", "EnteredInError" ] }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1Procedure/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "Period": { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/Provenance/{id}": { "get": { "summary": "Gets the Provenance resource for given provenanceId.", "description": "Fetches Provenance by id. Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. \n \n FHIR Resource: Provenance.recorded \n *\tAuthor Time Stamp \n \n FHIR Resource: Provenance.agent \n", "tags": [ "Provenance" ], "parameters": [ { "name": "id", "in": "path", "description": "provenanceId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": {} } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/RelatedPerson/{id}": { "get": { "summary": "Gets Related person resource for given relatedPersonId.", "description": "Gets Related person resource for given Related PersonId. A RelatedPerson resource is referenced in CareTeam resources.", "tags": [ "RelatedPerson" ], "parameters": [ { "name": "id", "in": "path", "description": "relatedPersonId", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "RelatedPerson", "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "patient": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "relationship": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "name": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfHumanName" } }, "definitions": { "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfHumanName": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/HumanName" } }, "HumanName": { "type": "object", "additionalProperties": false, "properties": { "use": { "type": "string" }, "text": { "type": "string" }, "family": { "type": "string" }, "given": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfGivenName" }, "givenElement": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfGivenElement" } } }, "ListOfGivenName": { "type": "array", "items": { "type": "string" } }, "ListOfGivenElement": { "type": "array", "items": { "type": "string" } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/RelatedPerson": { "get": { "summary": "Gets bundle of Related person resource.", "description": "Gets RelatedPerson resources referenced in CareTeam resources.", "tags": [ "RelatedPerson" ], "parameters": [ { "name": "_id", "in": "query", "description": "RelatedPerson id", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "patient", "in": "query", "description": "The patient this related person is related to.", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "name", "in": "query", "description": "A server defined search that may match any of the string fields in the HumanName, including firstName, lastName.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "BundleOfRelatedPerson", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "link": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfLink" }, "entry": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfEntryOfRelatedPerson" } }, "definitions": { "ListOfLink": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/Link" } }, "Link": { "type": "object", "additionalProperties": false, "properties": { "relation": { "type": "string" }, "url": { "type": "string" } } }, "ListOfEntryOfRelatedPerson": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/EntryOfRelatedPerson" } }, "EntryOfRelatedPerson": { "type": "object", "additionalProperties": false, "properties": { "fullUrl": { "type": "string" }, "resource": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/RelatedPerson" } } }, "RelatedPerson": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "patient": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ResourceReference" }, "relationship": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfCodeableConcept" }, "name": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfHumanName" } } }, "ResourceReference": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "ListOfCodeableConcept": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/CodeableConcept" } }, "CodeableConcept": { "type": "object", "additionalProperties": false, "properties": { "coding": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfCoding" }, "text": { "type": "string" } } }, "ListOfCoding": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/Coding" } }, "Coding": { "type": "object", "additionalProperties": false, "properties": { "system": { "type": "string" }, "code": { "type": "string" }, "display": { "type": "string" } } }, "ListOfHumanName": { "type": "array", "items": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/HumanName" } }, "HumanName": { "type": "object", "additionalProperties": false, "properties": { "use": { "type": "string" }, "text": { "type": "string" }, "family": { "type": "string" }, "given": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfGivenName" }, "givenElement": { "$ref": "#/paths/~1RelatedPerson/get/responses/200/content/application~1json/schema/definitions/ListOfGivenElement" } } }, "ListOfGivenName": { "type": "array", "items": { "type": "string" } }, "ListOfGivenElement": { "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Unexpected error occurred." }, "404": { "description": "PatientId not Found." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } } } }, "/metadata": { "get": { "parameters": [], "produces": [ "application/json" ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "title": "CapabilityStatement", "type": "object", "additionalProperties": false, "properties": { "resourceType": { "type": "string" }, "version": { "type": "string" }, "name": { "type": "string" }, "experimental": { "type": "boolean" }, "date": { "type": "string", "format": "date-time" }, "publisher": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string" }, "fhirVersion": { "type": "string" }, "format": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/ListOfFormat" }, "rest": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/ListOfRest" } }, "definitions": { "ListOfFormat": { "type": "array", "items": { "type": "string" } }, "ListOfRest": { "type": "array", "items": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/Rest" } }, "Rest": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string" }, "resource": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/ListOfResource" } } }, "ListOfResource": { "type": "array", "items": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/Resource" } }, "Resource": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "interaction": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/ListOfInteraction" }, "versioning": { "type": "string" }, "readHistory": { "type": "boolean" }, "updateCreate": { "type": "boolean" }, "searchParam": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/ListOfSearchParam" } } }, "ListOfInteraction": { "type": "array", "items": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/Interaction" } }, "Interaction": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" } } }, "ListOfSearchParam": { "type": "array", "items": { "$ref": "#/paths/~1metadata/get/responses/200/content/application~1json/schema/definitions/SearchParam" } }, "SearchParam": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "documentation": { "type": "string" } } } } } } } }, "404": { "description": "Resource not Found." }, "400": { "description": "Unexpected error occurred." }, "401": { "description": "Login credentials denied Access." }, "403": { "description": "Access denied for this resource with the given credentials." }, "500": { "description": "Internal exception." } }, "security": [], "summary": "Gets CapabilityStatement.", "tags": [ "CapabilityStatement" ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } } }