benchmarks/configs/linux4health/openapi.json
{
"openapi": "3.0.0",
"info": {
"title": "Simplified FHIR API",
"description": "A simplified version of the HL7 FHIR API",
"version": "4.0.1"
},
"servers": [
{
"url": "/fhir-server/api/v4"
}
],
"x-ibm-configuration": {
"gateway": "datapower-api-gateway",
"type": "rest",
"phase": "realized",
"enforced": true,
"testable": true,
"cors": {
"enabled": true
},
"assembly": {
"execute": [
{
"invoke": {
"version": "2.0.0",
"title": "invoke",
"header-control": {
"type": "blacklist",
"values": [
]
},
"parameter-control": {
"type": "whitelist",
"values": [
]
},
"timeout": 60,
"verb": "keep",
"cache-response": "protocol",
"cache-ttl": 900,
"stop-on-error": [
],
"target-url": "$(target-url)$(api.operation.path)$(request.search)"
}
}
],
"catch": [
]
},
"properties": {
"target-url": {
"value": "https://localhost/fhir-server/api/v4/",
"description": "The URL of the target service",
"encoded": false
}
},
"activity-log": {
"enabled": true,
"error-content": "header",
"success-content": "activity"
},
"application-authentication": {
"certificate": false
},
"catalogs": {
}
},
"tags": [
{
"name": "AllergyIntolerance"
},
{
"name": "CarePlan"
},
{
"name": "CareTeam"
},
{
"name": "CodeSystem"
},
{
"name": "Condition"
},
{
"name": "Consent"
},
{
"name": "Coverage"
},
{
"name": "Device"
},
{
"name": "Group"
},
{
"name": "Provenance"
},
{
"name": "DiagnosticReport"
},
{
"name": "ExplanationOfBenefit"
},
{
"name": "List"
},
{
"name": "DocumentReference"
},
{
"name": "Observation"
},
{
"name": "MedicationAdministration"
},
{
"name": "Encounter"
},
{
"name": "Procedure"
},
{
"name": "MedicationRequest"
},
{
"name": "Goal"
},
{
"name": "Immunization"
},
{
"name": "Location"
},
{
"name": "Medication"
},
{
"name": "MedicationDispense"
},
{
"name": "MedicationStatement"
},
{
"name": "Organization"
},
{
"name": "Patient"
},
{
"name": "Practitioner"
},
{
"name": "PractitionerRole"
},
{
"name": "StructureDefinition"
},
{
"name": "ValueSet"
}
],
"paths": {
"/AllergyIntolerance": {
"post": {
"tags": [
"AllergyIntolerance"
],
"summary": "Create an AllergyIntolerance resource",
"operationId": "createAllergyIntolerance",
"responses": {
"201": {
"description": "Create AllergyIntolerance operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/AllergyIntolerance"
}
},
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources",
"operationId": "searchAllergyIntolerance",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/AllergyIntolerance/_search": {
"post": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources",
"operationId": "searchViaPostAllergyIntolerance",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/AllergyIntolerance/{id}/_history/{vid}": {
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Read specific version of an AllergyIntolerance resource",
"operationId": "vreadAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/AllergyIntolerance"
}
}
}
}
}
}
},
"/AllergyIntolerance/{id}": {
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Read an AllergyIntolerance resource",
"operationId": "readAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/AllergyIntolerance"
}
}
}
}
}
},
"put": {
"tags": [
"AllergyIntolerance"
],
"summary": "Update an existing AllergyIntolerance resource",
"operationId": "updateAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update AllergyIntolerance operation successful"
},
"201": {
"description": "Create AllergyIntolerance operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/AllergyIntolerance"
}
},
"delete": {
"tags": [
"AllergyIntolerance"
],
"summary": "Delete an AllergyIntolerance resource",
"operationId": "deleteAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete AllergyIntolerance operation successful"
}
}
}
},
"/AllergyIntolerance/{id}/_history": {
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Return the history of an AllergyIntolerance resource",
"operationId": "historyAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/AllergyIntolerance/_history": {
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Get the whole system history for AllergyIntolerance resources",
"operationId": "wholeSystemHistoryAllergyIntolerance",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CarePlan": {
"post": {
"tags": [
"CarePlan"
],
"summary": "Create a CarePlan resource",
"operationId": "createCarePlan",
"responses": {
"201": {
"description": "Create CarePlan operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/CarePlan"
}
},
"get": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources",
"operationId": "searchCarePlan",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CarePlan/_search": {
"post": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources",
"operationId": "searchViaPostCarePlan",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CarePlan/{id}/_history/{vid}": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Read specific version of a CarePlan resource",
"operationId": "vreadCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CarePlan"
}
}
}
}
}
}
},
"/CarePlan/{id}": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Read a CarePlan resource",
"operationId": "readCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CarePlan"
}
}
}
}
}
},
"put": {
"tags": [
"CarePlan"
],
"summary": "Update an existing CarePlan resource",
"operationId": "updateCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update CarePlan operation successful"
},
"201": {
"description": "Create CarePlan operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/CarePlan"
}
},
"delete": {
"tags": [
"CarePlan"
],
"summary": "Delete a CarePlan resource",
"operationId": "deleteCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete CarePlan operation successful"
}
}
}
},
"/CarePlan/{id}/_history": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Return the history of a CarePlan resource",
"operationId": "historyCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CarePlan/_history": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Get the whole system history for CarePlan resources",
"operationId": "wholeSystemHistoryCarePlan",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CareTeam": {
"post": {
"tags": [
"CareTeam"
],
"summary": "Create a CareTeam resource",
"operationId": "createCareTeam",
"responses": {
"201": {
"description": "Create CareTeam operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/CareTeam"
}
},
"get": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources",
"operationId": "searchCareTeam",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CareTeam/_search": {
"post": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources",
"operationId": "searchViaPostCareTeam",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CareTeam/{id}/_history/{vid}": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Read specific version of a CareTeam resource",
"operationId": "vreadCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CareTeam"
}
}
}
}
}
}
},
"/CareTeam/{id}": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Read a CareTeam resource",
"operationId": "readCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CareTeam"
}
}
}
}
}
},
"put": {
"tags": [
"CareTeam"
],
"summary": "Update an existing CareTeam resource",
"operationId": "updateCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update CareTeam operation successful"
},
"201": {
"description": "Create CareTeam operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/CareTeam"
}
},
"delete": {
"tags": [
"CareTeam"
],
"summary": "Delete a CareTeam resource",
"operationId": "deleteCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete CareTeam operation successful"
}
}
}
},
"/CareTeam/{id}/_history": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Return the history of a CareTeam resource",
"operationId": "historyCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CareTeam/_history": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Get the whole system history for CareTeam resources",
"operationId": "wholeSystemHistoryCareTeam",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CodeSystem": {
"post": {
"tags": [
"CodeSystem"
],
"summary": "Create a CodeSystem resource",
"operationId": "createCodeSystem",
"responses": {
"201": {
"description": "Create CodeSystem operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/CodeSystem"
}
},
"get": {
"tags": [
"CodeSystem"
],
"summary": "Search for CodeSystem resources",
"operationId": "searchCodeSystem",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "publisher",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jurisdiction",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "content-mode",
"description": "not-present | example | fragment | complete | supplement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "A code defined in the code system",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "A language in which a designation is provided",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "version",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "supplements",
"description": "Find code system supplements for the referenced code system",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-value",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "system",
"description": "The system for any codes defined by this code system (same as 'url')",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CodeSystem operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CodeSystem/_search": {
"post": {
"tags": [
"CodeSystem"
],
"summary": "Search for CodeSystem resources",
"operationId": "searchViaPostCodeSystem",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "publisher",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jurisdiction",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "content-mode",
"description": "not-present | example | fragment | complete | supplement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "A code defined in the code system",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "A language in which a designation is provided",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "version",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "supplements",
"description": "Find code system supplements for the referenced code system",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-value",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "system",
"description": "The system for any codes defined by this code system (same as 'url')",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CodeSystem operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CodeSystem/{id}/_history/{vid}": {
"get": {
"tags": [
"CodeSystem"
],
"summary": "Read specific version of a CodeSystem resource",
"operationId": "vreadCodeSystem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read CodeSystem operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CodeSystem"
}
}
}
}
}
}
},
"/CodeSystem/{id}": {
"get": {
"tags": [
"CodeSystem"
],
"summary": "Read a CodeSystem resource",
"operationId": "readCodeSystem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read CodeSystem operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CodeSystem"
}
}
}
}
}
},
"put": {
"tags": [
"CodeSystem"
],
"summary": "Update an existing CodeSystem resource",
"operationId": "updateCodeSystem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update CodeSystem operation successful"
},
"201": {
"description": "Create CodeSystem operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/CodeSystem"
}
},
"delete": {
"tags": [
"CodeSystem"
],
"summary": "Delete a CodeSystem resource",
"operationId": "deleteCodeSystem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete CodeSystem operation successful"
}
}
}
},
"/CodeSystem/{id}/_history": {
"get": {
"tags": [
"CodeSystem"
],
"summary": "Return the history of a CodeSystem resource",
"operationId": "historyCodeSystem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History CodeSystem operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/CodeSystem/_history": {
"get": {
"tags": [
"CodeSystem"
],
"summary": "Get the whole system history for CodeSystem resources",
"operationId": "wholeSystemHistoryCodeSystem",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Condition": {
"post": {
"tags": [
"Condition"
],
"summary": "Create a Condition resource",
"operationId": "createCondition",
"responses": {
"201": {
"description": "Create Condition operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Condition"
}
},
"get": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources",
"operationId": "searchCondition",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Condition/_search": {
"post": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources",
"operationId": "searchViaPostCondition",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Condition/{id}/_history/{vid}": {
"get": {
"tags": [
"Condition"
],
"summary": "Read specific version of a Condition resource",
"operationId": "vreadCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Condition"
}
}
}
}
}
}
},
"/Condition/{id}": {
"get": {
"tags": [
"Condition"
],
"summary": "Read a Condition resource",
"operationId": "readCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Condition"
}
}
}
}
}
},
"put": {
"tags": [
"Condition"
],
"summary": "Update an existing Condition resource",
"operationId": "updateCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Condition operation successful"
},
"201": {
"description": "Create Condition operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Condition"
}
},
"delete": {
"tags": [
"Condition"
],
"summary": "Delete a Condition resource",
"operationId": "deleteCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Condition operation successful"
}
}
}
},
"/Condition/{id}/_history": {
"get": {
"tags": [
"Condition"
],
"summary": "Return the history of a Condition resource",
"operationId": "historyCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Condition/_history": {
"get": {
"tags": [
"Condition"
],
"summary": "Get the whole system history for Condition resources",
"operationId": "wholeSystemHistoryCondition",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Consent": {
"post": {
"tags": [
"Consent"
],
"summary": "Create a Consent resource",
"operationId": "createConsent",
"responses": {
"201": {
"description": "Create Consent operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Consent"
}
},
"get": {
"tags": [
"Consent"
],
"summary": "Search for Consent resources",
"operationId": "searchConsent",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "period",
"description": "Timeframe for this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | proposed | active | rejected | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "scope",
"description": "Which of the four areas this resource covers (extensible)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the consent statement - for indexing/retrieval",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Security Labels that define affected resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "purpose",
"description": "Context of activities covered by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "action",
"description": "Actions controlled by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "Custodian of the consent",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data",
"description": "The actual data reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source-reference",
"description": "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "consentor",
"description": "Who is agreeing to the policy and rules",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actor",
"description": "Resource for the actor (or group, by role)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Consent operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Consent/_search": {
"post": {
"tags": [
"Consent"
],
"summary": "Search for Consent resources",
"operationId": "searchViaPostConsent",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "period",
"description": "Timeframe for this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | proposed | active | rejected | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "scope",
"description": "Which of the four areas this resource covers (extensible)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the consent statement - for indexing/retrieval",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Security Labels that define affected resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "purpose",
"description": "Context of activities covered by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "action",
"description": "Actions controlled by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "Custodian of the consent",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data",
"description": "The actual data reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source-reference",
"description": "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "consentor",
"description": "Who is agreeing to the policy and rules",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actor",
"description": "Resource for the actor (or group, by role)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Consent operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Consent/{id}/_history/{vid}": {
"get": {
"tags": [
"Consent"
],
"summary": "Read specific version of a Consent resource",
"operationId": "vreadConsent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Consent operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Consent"
}
}
}
}
}
}
},
"/Consent/{id}": {
"get": {
"tags": [
"Consent"
],
"summary": "Read a Consent resource",
"operationId": "readConsent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Consent operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Consent"
}
}
}
}
}
},
"put": {
"tags": [
"Consent"
],
"summary": "Update an existing Consent resource",
"operationId": "updateConsent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Consent operation successful"
},
"201": {
"description": "Create Consent operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Consent"
}
},
"delete": {
"tags": [
"Consent"
],
"summary": "Delete a Consent resource",
"operationId": "deleteConsent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Consent operation successful"
}
}
}
},
"/Consent/{id}/_history": {
"get": {
"tags": [
"Consent"
],
"summary": "Return the history of a Consent resource",
"operationId": "historyConsent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Consent operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Consent/_history": {
"get": {
"tags": [
"Consent"
],
"summary": "Get the whole system history for Consent resources",
"operationId": "wholeSystemHistoryConsent",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Coverage": {
"post": {
"tags": [
"Coverage"
],
"summary": "Create a Coverage resource",
"operationId": "createCoverage",
"responses": {
"201": {
"description": "Create Coverage operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Coverage"
}
},
"get": {
"tags": [
"Coverage"
],
"summary": "Search for Coverage resources",
"operationId": "searchCoverage",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "dependent",
"description": "Dependent number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-value",
"description": "Value of the class (eg. Plan number, group number)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the Coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The kind of coverage (health plan, auto, Workers Compensation)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-type",
"description": "Coverage class (eg. plan, group)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The primary identifier of the insured and the coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "beneficiary",
"description": "Covered party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Retrieve coverages for a patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payor",
"description": "The identity of the insurer or party paying for services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "policy-holder",
"description": "Reference to the policyholder",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subscriber",
"description": "Reference to the subscriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Coverage/_search": {
"post": {
"tags": [
"Coverage"
],
"summary": "Search for Coverage resources",
"operationId": "searchViaPostCoverage",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "dependent",
"description": "Dependent number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-value",
"description": "Value of the class (eg. Plan number, group number)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the Coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The kind of coverage (health plan, auto, Workers Compensation)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-type",
"description": "Coverage class (eg. plan, group)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The primary identifier of the insured and the coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "beneficiary",
"description": "Covered party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Retrieve coverages for a patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payor",
"description": "The identity of the insurer or party paying for services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "policy-holder",
"description": "Reference to the policyholder",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subscriber",
"description": "Reference to the subscriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Coverage/{id}/_history/{vid}": {
"get": {
"tags": [
"Coverage"
],
"summary": "Read specific version of a Coverage resource",
"operationId": "vreadCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Coverage"
}
}
}
}
}
}
},
"/Coverage/{id}": {
"get": {
"tags": [
"Coverage"
],
"summary": "Read a Coverage resource",
"operationId": "readCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Coverage"
}
}
}
}
}
},
"put": {
"tags": [
"Coverage"
],
"summary": "Update an existing Coverage resource",
"operationId": "updateCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Coverage operation successful"
},
"201": {
"description": "Create Coverage operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Coverage"
}
},
"delete": {
"tags": [
"Coverage"
],
"summary": "Delete a Coverage resource",
"operationId": "deleteCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Coverage operation successful"
}
}
}
},
"/Coverage/{id}/_history": {
"get": {
"tags": [
"Coverage"
],
"summary": "Return the history of a Coverage resource",
"operationId": "historyCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Coverage/_history": {
"get": {
"tags": [
"Coverage"
],
"summary": "Get the whole system history for Coverage resources",
"operationId": "wholeSystemHistoryCoverage",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device": {
"post": {
"tags": [
"Device"
],
"summary": "Create a Device resource",
"operationId": "createDevice",
"responses": {
"201": {
"description": "Create Device operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Device"
}
},
"get": {
"tags": [
"Device"
],
"summary": "Search for Device resources",
"operationId": "searchDevice",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "manufacturer",
"description": "The manufacturer of the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "udi-di",
"description": "The udi Device Identifier (DI)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "udi-carrier",
"description": "UDI Barcode (RFID or other technology) string in *HRF* format.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "model",
"description": "The model of the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device-name",
"description": "A server defined search that may match any of the string fields in Device.deviceName or Device.type.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "active | inactive | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Instance id from manufacturer, owner, and others",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Patient information, if the resource is affixed to a person",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization responsible for the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "A location, where the resource is found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Network address to contact device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Device operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/_search": {
"post": {
"tags": [
"Device"
],
"summary": "Search for Device resources",
"operationId": "searchViaPostDevice",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "manufacturer",
"description": "The manufacturer of the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "udi-di",
"description": "The udi Device Identifier (DI)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "udi-carrier",
"description": "UDI Barcode (RFID or other technology) string in *HRF* format.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "model",
"description": "The model of the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device-name",
"description": "A server defined search that may match any of the string fields in Device.deviceName or Device.type.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "active | inactive | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Instance id from manufacturer, owner, and others",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Patient information, if the resource is affixed to a person",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization responsible for the device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "A location, where the resource is found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Network address to contact device",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Device operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/_history/{vid}": {
"get": {
"tags": [
"Device"
],
"summary": "Read specific version of a Device resource",
"operationId": "vreadDevice",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Device operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Device"
}
}
}
}
}
}
},
"/Device/{id}": {
"get": {
"tags": [
"Device"
],
"summary": "Read a Device resource",
"operationId": "readDevice",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Device operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Device"
}
}
}
}
}
},
"put": {
"tags": [
"Device"
],
"summary": "Update an existing Device resource",
"operationId": "updateDevice",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Device operation successful"
},
"201": {
"description": "Create Device operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Device"
}
},
"delete": {
"tags": [
"Device"
],
"summary": "Delete a Device resource",
"operationId": "deleteDevice",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Device operation successful"
}
}
}
},
"/Device/{id}/_history": {
"get": {
"tags": [
"Device"
],
"summary": "Return the history of a Device resource",
"operationId": "historyDevice",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Device operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/_history": {
"get": {
"tags": [
"Device"
],
"summary": "Get the whole system history for Device resources",
"operationId": "wholeSystemHistoryDevice",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/Group": {
"get": {
"tags": [
"Group"
],
"summary": "Search for Group resources within Device compartment",
"operationId": "searchDeviceCompartmentGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/Group/_search": {
"post": {
"tags": [
"Group"
],
"summary": "Search for Group resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/Provenance": {
"get": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within Device compartment",
"operationId": "searchDeviceCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/Provenance/_search": {
"post": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/DiagnosticReport": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Device compartment",
"operationId": "searchDeviceCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/DiagnosticReport/_search": {
"post": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/ExplanationOfBenefit": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Device compartment",
"operationId": "searchDeviceCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/ExplanationOfBenefit/_search": {
"post": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/List": {
"get": {
"tags": [
"List"
],
"summary": "Search for List resources within Device compartment",
"operationId": "searchDeviceCompartmentList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/List/_search": {
"post": {
"tags": [
"List"
],
"summary": "Search for List resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/DocumentReference": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Device compartment",
"operationId": "searchDeviceCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/DocumentReference/_search": {
"post": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/Observation": {
"get": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Device compartment",
"operationId": "searchDeviceCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/Observation/_search": {
"post": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/MedicationAdministration": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Device compartment",
"operationId": "searchDeviceCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Device/{id}/MedicationAdministration/_search": {
"post": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Device compartment",
"operationId": "searchViaPostDeviceCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DiagnosticReport": {
"post": {
"tags": [
"DiagnosticReport"
],
"summary": "Create a DiagnosticReport resource",
"operationId": "createDiagnosticReport",
"responses": {
"201": {
"description": "Create DiagnosticReport operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/DiagnosticReport"
}
},
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources",
"operationId": "searchDiagnosticReport",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DiagnosticReport/_search": {
"post": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources",
"operationId": "searchViaPostDiagnosticReport",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DiagnosticReport/{id}/_history/{vid}": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Read specific version of a DiagnosticReport resource",
"operationId": "vreadDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/DiagnosticReport"
}
}
}
}
}
}
},
"/DiagnosticReport/{id}": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Read a DiagnosticReport resource",
"operationId": "readDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/DiagnosticReport"
}
}
}
}
}
},
"put": {
"tags": [
"DiagnosticReport"
],
"summary": "Update an existing DiagnosticReport resource",
"operationId": "updateDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update DiagnosticReport operation successful"
},
"201": {
"description": "Create DiagnosticReport operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/DiagnosticReport"
}
},
"delete": {
"tags": [
"DiagnosticReport"
],
"summary": "Delete a DiagnosticReport resource",
"operationId": "deleteDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete DiagnosticReport operation successful"
}
}
}
},
"/DiagnosticReport/{id}/_history": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Return the history of a DiagnosticReport resource",
"operationId": "historyDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DiagnosticReport/_history": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Get the whole system history for DiagnosticReport resources",
"operationId": "wholeSystemHistoryDiagnosticReport",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DocumentReference": {
"post": {
"tags": [
"DocumentReference"
],
"summary": "Create a DocumentReference resource",
"operationId": "createDocumentReference",
"responses": {
"201": {
"description": "Create DocumentReference operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/DocumentReference"
}
},
"get": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources",
"operationId": "searchDocumentReference",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DocumentReference/_search": {
"post": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources",
"operationId": "searchViaPostDocumentReference",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DocumentReference/{id}/_history/{vid}": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Read specific version of a DocumentReference resource",
"operationId": "vreadDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/DocumentReference"
}
}
}
}
}
}
},
"/DocumentReference/{id}": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Read a DocumentReference resource",
"operationId": "readDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/DocumentReference"
}
}
}
}
}
},
"put": {
"tags": [
"DocumentReference"
],
"summary": "Update an existing DocumentReference resource",
"operationId": "updateDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update DocumentReference operation successful"
},
"201": {
"description": "Create DocumentReference operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/DocumentReference"
}
},
"delete": {
"tags": [
"DocumentReference"
],
"summary": "Delete a DocumentReference resource",
"operationId": "deleteDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete DocumentReference operation successful"
}
}
}
},
"/DocumentReference/{id}/_history": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Return the history of a DocumentReference resource",
"operationId": "historyDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/DocumentReference/_history": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Get the whole system history for DocumentReference resources",
"operationId": "wholeSystemHistoryDocumentReference",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter": {
"post": {
"tags": [
"Encounter"
],
"summary": "Create an Encounter resource",
"operationId": "createEncounter",
"responses": {
"201": {
"description": "Create Encounter operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Encounter"
}
},
"get": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources",
"operationId": "searchEncounter",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/_search": {
"post": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources",
"operationId": "searchViaPostEncounter",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/_history/{vid}": {
"get": {
"tags": [
"Encounter"
],
"summary": "Read specific version of an Encounter resource",
"operationId": "vreadEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Encounter"
}
}
}
}
}
}
},
"/Encounter/{id}": {
"get": {
"tags": [
"Encounter"
],
"summary": "Read an Encounter resource",
"operationId": "readEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Encounter"
}
}
}
}
}
},
"put": {
"tags": [
"Encounter"
],
"summary": "Update an existing Encounter resource",
"operationId": "updateEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Encounter operation successful"
},
"201": {
"description": "Create Encounter operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Encounter"
}
},
"delete": {
"tags": [
"Encounter"
],
"summary": "Delete an Encounter resource",
"operationId": "deleteEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Encounter operation successful"
}
}
}
},
"/Encounter/{id}/_history": {
"get": {
"tags": [
"Encounter"
],
"summary": "Return the history of an Encounter resource",
"operationId": "historyEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/_history": {
"get": {
"tags": [
"Encounter"
],
"summary": "Get the whole system history for Encounter resources",
"operationId": "wholeSystemHistoryEncounter",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/CareTeam": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within Encounter compartment",
"operationId": "searchEncounterCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/CareTeam/_search": {
"post": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/DiagnosticReport": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Encounter compartment",
"operationId": "searchEncounterCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/DiagnosticReport/_search": {
"post": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/ExplanationOfBenefit": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Encounter compartment",
"operationId": "searchEncounterCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/ExplanationOfBenefit/_search": {
"post": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/CarePlan": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within Encounter compartment",
"operationId": "searchEncounterCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/CarePlan/_search": {
"post": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Encounter": {
"get": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within Encounter compartment",
"operationId": "searchEncounterCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Encounter/_search": {
"post": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Procedure": {
"get": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within Encounter compartment",
"operationId": "searchEncounterCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Procedure/_search": {
"post": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/DocumentReference": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Encounter compartment",
"operationId": "searchEncounterCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/DocumentReference/_search": {
"post": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Condition": {
"get": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within Encounter compartment",
"operationId": "searchEncounterCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Condition/_search": {
"post": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/MedicationRequest": {
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources within Encounter compartment",
"operationId": "searchEncounterCompartmentMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/MedicationRequest/_search": {
"post": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Observation": {
"get": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Encounter compartment",
"operationId": "searchEncounterCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/Observation/_search": {
"post": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/MedicationAdministration": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Encounter compartment",
"operationId": "searchEncounterCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Encounter/{id}/MedicationAdministration/_search": {
"post": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Encounter compartment",
"operationId": "searchViaPostEncounterCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ExplanationOfBenefit": {
"post": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Create an ExplanationOfBenefit resource",
"operationId": "createExplanationOfBenefit",
"responses": {
"201": {
"description": "Create ExplanationOfBenefit operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ExplanationOfBenefit"
}
},
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources",
"operationId": "searchExplanationOfBenefit",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ExplanationOfBenefit/_search": {
"post": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources",
"operationId": "searchViaPostExplanationOfBenefit",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ExplanationOfBenefit/{id}/_history/{vid}": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Read specific version of an ExplanationOfBenefit resource",
"operationId": "vreadExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/ExplanationOfBenefit"
}
}
}
}
}
}
},
"/ExplanationOfBenefit/{id}": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Read an ExplanationOfBenefit resource",
"operationId": "readExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/ExplanationOfBenefit"
}
}
}
}
}
},
"put": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Update an existing ExplanationOfBenefit resource",
"operationId": "updateExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update ExplanationOfBenefit operation successful"
},
"201": {
"description": "Create ExplanationOfBenefit operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ExplanationOfBenefit"
}
},
"delete": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Delete an ExplanationOfBenefit resource",
"operationId": "deleteExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete ExplanationOfBenefit operation successful"
}
}
}
},
"/ExplanationOfBenefit/{id}/_history": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Return the history of an ExplanationOfBenefit resource",
"operationId": "historyExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ExplanationOfBenefit/_history": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Get the whole system history for ExplanationOfBenefit resources",
"operationId": "wholeSystemHistoryExplanationOfBenefit",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Goal": {
"post": {
"tags": [
"Goal"
],
"summary": "Create a Goal resource",
"operationId": "createGoal",
"responses": {
"201": {
"description": "Create Goal operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Goal"
}
},
"get": {
"tags": [
"Goal"
],
"summary": "Search for Goal resources",
"operationId": "searchGoal",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "target-date",
"description": "Reach goal on or before",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "start-date",
"description": "When goal pursuit begins",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "E.g. Treatment, dietary, behavioral, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "achievement-status",
"description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycle-status",
"description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who this goal is intended for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Goal operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Goal/_search": {
"post": {
"tags": [
"Goal"
],
"summary": "Search for Goal resources",
"operationId": "searchViaPostGoal",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "target-date",
"description": "Reach goal on or before",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "start-date",
"description": "When goal pursuit begins",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "E.g. Treatment, dietary, behavioral, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "achievement-status",
"description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycle-status",
"description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who this goal is intended for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Goal operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Goal/{id}/_history/{vid}": {
"get": {
"tags": [
"Goal"
],
"summary": "Read specific version of a Goal resource",
"operationId": "vreadGoal",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Goal operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Goal"
}
}
}
}
}
}
},
"/Goal/{id}": {
"get": {
"tags": [
"Goal"
],
"summary": "Read a Goal resource",
"operationId": "readGoal",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Goal operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Goal"
}
}
}
}
}
},
"put": {
"tags": [
"Goal"
],
"summary": "Update an existing Goal resource",
"operationId": "updateGoal",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Goal operation successful"
},
"201": {
"description": "Create Goal operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Goal"
}
},
"delete": {
"tags": [
"Goal"
],
"summary": "Delete a Goal resource",
"operationId": "deleteGoal",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Goal operation successful"
}
}
}
},
"/Goal/{id}/_history": {
"get": {
"tags": [
"Goal"
],
"summary": "Return the history of a Goal resource",
"operationId": "historyGoal",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Goal operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Goal/_history": {
"get": {
"tags": [
"Goal"
],
"summary": "Get the whole system history for Goal resources",
"operationId": "wholeSystemHistoryGoal",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Group": {
"post": {
"tags": [
"Group"
],
"summary": "Create a Group resource",
"operationId": "createGroup",
"responses": {
"201": {
"description": "Create Group operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Group"
}
},
"get": {
"tags": [
"Group"
],
"summary": "Search for Group resources",
"operationId": "searchGroup",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Group/_search": {
"post": {
"tags": [
"Group"
],
"summary": "Search for Group resources",
"operationId": "searchViaPostGroup",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Group/{id}/_history/{vid}": {
"get": {
"tags": [
"Group"
],
"summary": "Read specific version of a Group resource",
"operationId": "vreadGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
}
}
}
}
},
"/Group/{id}": {
"get": {
"tags": [
"Group"
],
"summary": "Read a Group resource",
"operationId": "readGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
}
}
}
},
"put": {
"tags": [
"Group"
],
"summary": "Update an existing Group resource",
"operationId": "updateGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Group operation successful"
},
"201": {
"description": "Create Group operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Group"
}
},
"delete": {
"tags": [
"Group"
],
"summary": "Delete a Group resource",
"operationId": "deleteGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Group operation successful"
}
}
}
},
"/Group/{id}/_history": {
"get": {
"tags": [
"Group"
],
"summary": "Return the history of a Group resource",
"operationId": "historyGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Group/_history": {
"get": {
"tags": [
"Group"
],
"summary": "Get the whole system history for Group resources",
"operationId": "wholeSystemHistoryGroup",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Group/{id}/$export": {
"get": {
"tags": [
"Group"
],
"summary": "Export Group data from the FHIR server",
"operationId": "getExportGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_outputFormatParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_typeParam"
}
],
"responses": {
"202": {
"description": "Export job is initiated",
"headers": {
"Content-Location": {
"description": "The polling location",
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"tags": [
"Group"
],
"summary": "Export Group data from the FHIR server",
"operationId": "postExportGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Parameters"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Export job is initiated",
"headers": {
"Content-Location": {
"description": "The polling location",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/Immunization": {
"post": {
"tags": [
"Immunization"
],
"summary": "Create an Immunization resource",
"operationId": "createImmunization",
"responses": {
"201": {
"description": "Create Immunization operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Immunization"
}
},
"get": {
"tags": [
"Immunization"
],
"summary": "Search for Immunization resources",
"operationId": "searchImmunization",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction-date",
"description": "When reaction started",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Vaccine Lot Number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "series",
"description": "The series being followed by the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Immunization event status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "vaccine-code",
"description": "Vaccine Product Administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target-disease",
"description": "The target disease the dose is being administered against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status-reason",
"description": "Reason why the vaccine was not administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Reason why the vaccine was administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction",
"description": "Additional information on reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Vaccine Manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The practitioner or organization who played a role in the vaccination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "The service delivery location or facility in which the vaccine was / was to be administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Why immunization occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Immunization/_search": {
"post": {
"tags": [
"Immunization"
],
"summary": "Search for Immunization resources",
"operationId": "searchViaPostImmunization",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction-date",
"description": "When reaction started",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Vaccine Lot Number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "series",
"description": "The series being followed by the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Immunization event status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "vaccine-code",
"description": "Vaccine Product Administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target-disease",
"description": "The target disease the dose is being administered against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status-reason",
"description": "Reason why the vaccine was not administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Reason why the vaccine was administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction",
"description": "Additional information on reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Vaccine Manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The practitioner or organization who played a role in the vaccination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "The service delivery location or facility in which the vaccine was / was to be administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Why immunization occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Immunization/{id}/_history/{vid}": {
"get": {
"tags": [
"Immunization"
],
"summary": "Read specific version of an Immunization resource",
"operationId": "vreadImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Immunization"
}
}
}
}
}
}
},
"/Immunization/{id}": {
"get": {
"tags": [
"Immunization"
],
"summary": "Read an Immunization resource",
"operationId": "readImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Immunization"
}
}
}
}
}
},
"put": {
"tags": [
"Immunization"
],
"summary": "Update an existing Immunization resource",
"operationId": "updateImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Immunization operation successful"
},
"201": {
"description": "Create Immunization operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Immunization"
}
},
"delete": {
"tags": [
"Immunization"
],
"summary": "Delete an Immunization resource",
"operationId": "deleteImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Immunization operation successful"
}
}
}
},
"/Immunization/{id}/_history": {
"get": {
"tags": [
"Immunization"
],
"summary": "Return the history of an Immunization resource",
"operationId": "historyImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Immunization/_history": {
"get": {
"tags": [
"Immunization"
],
"summary": "Get the whole system history for Immunization resources",
"operationId": "wholeSystemHistoryImmunization",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/List": {
"post": {
"tags": [
"List"
],
"summary": "Create a List resource",
"operationId": "createList",
"responses": {
"201": {
"description": "Create List operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/List"
}
},
"get": {
"tags": [
"List"
],
"summary": "Search for List resources",
"operationId": "searchList",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/List/_search": {
"post": {
"tags": [
"List"
],
"summary": "Search for List resources",
"operationId": "searchViaPostList",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/List/{id}/_history/{vid}": {
"get": {
"tags": [
"List"
],
"summary": "Read specific version of a List resource",
"operationId": "vreadList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/List"
}
}
}
}
}
}
},
"/List/{id}": {
"get": {
"tags": [
"List"
],
"summary": "Read a List resource",
"operationId": "readList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/List"
}
}
}
}
}
},
"put": {
"tags": [
"List"
],
"summary": "Update an existing List resource",
"operationId": "updateList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update List operation successful"
},
"201": {
"description": "Create List operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/List"
}
},
"delete": {
"tags": [
"List"
],
"summary": "Delete a List resource",
"operationId": "deleteList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete List operation successful"
}
}
}
},
"/List/{id}/_history": {
"get": {
"tags": [
"List"
],
"summary": "Return the history of a List resource",
"operationId": "historyList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/List/_history": {
"get": {
"tags": [
"List"
],
"summary": "Get the whole system history for List resources",
"operationId": "wholeSystemHistoryList",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Location": {
"post": {
"tags": [
"Location"
],
"summary": "Create a Location resource",
"operationId": "createLocation",
"responses": {
"201": {
"description": "Create Location operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Location"
}
},
"get": {
"tags": [
"Location"
],
"summary": "Search for Location resources",
"operationId": "searchLocation",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "address-country",
"description": "A country specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "A postal code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "A state specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "A city specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "A (part of the) address of the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A portion of the location's name or alias",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "operational-status",
"description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "A code for the type of location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Searches for locations with a specific kind of status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "An identifier for the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "A use code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partof",
"description": "A location of which this location is a part",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "Searches for locations that are managed by the provided organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "near",
"description": "Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).\nIf the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Location operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Location/_search": {
"post": {
"tags": [
"Location"
],
"summary": "Search for Location resources",
"operationId": "searchViaPostLocation",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "address-country",
"description": "A country specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "A postal code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "A state specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "A city specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "A (part of the) address of the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A portion of the location's name or alias",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "operational-status",
"description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "A code for the type of location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Searches for locations with a specific kind of status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "An identifier for the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "A use code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partof",
"description": "A location of which this location is a part",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "Searches for locations that are managed by the provided organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "near",
"description": "Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).\nIf the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Location operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Location/{id}/_history/{vid}": {
"get": {
"tags": [
"Location"
],
"summary": "Read specific version of a Location resource",
"operationId": "vreadLocation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Location operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
}
}
}
},
"/Location/{id}": {
"get": {
"tags": [
"Location"
],
"summary": "Read a Location resource",
"operationId": "readLocation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Location operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
}
}
},
"put": {
"tags": [
"Location"
],
"summary": "Update an existing Location resource",
"operationId": "updateLocation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Location operation successful"
},
"201": {
"description": "Create Location operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Location"
}
},
"delete": {
"tags": [
"Location"
],
"summary": "Delete a Location resource",
"operationId": "deleteLocation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Location operation successful"
}
}
}
},
"/Location/{id}/_history": {
"get": {
"tags": [
"Location"
],
"summary": "Return the history of a Location resource",
"operationId": "historyLocation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Location operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Location/_history": {
"get": {
"tags": [
"Location"
],
"summary": "Get the whole system history for Location resources",
"operationId": "wholeSystemHistoryLocation",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Medication": {
"post": {
"tags": [
"Medication"
],
"summary": "Create a Medication resource",
"operationId": "createMedication",
"responses": {
"201": {
"description": "Create Medication operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Medication"
}
},
"get": {
"tags": [
"Medication"
],
"summary": "Search for Medication resources",
"operationId": "searchMedication",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "expiration-date",
"description": "Returns medications in a batch with this expiration date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "form",
"description": "Returns medications for a specific dose form",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Returns medications in a batch with this lot number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ingredient-code",
"description": "Returns medications for this ingredient code",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Returns medications with this external identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Returns medications for this status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ingredient",
"description": "Returns medications for this ingredient reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Returns medications made or sold for this manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Medication operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Medication/_search": {
"post": {
"tags": [
"Medication"
],
"summary": "Search for Medication resources",
"operationId": "searchViaPostMedication",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "expiration-date",
"description": "Returns medications in a batch with this expiration date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "form",
"description": "Returns medications for a specific dose form",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Returns medications in a batch with this lot number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ingredient-code",
"description": "Returns medications for this ingredient code",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Returns medications with this external identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Returns medications for this status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ingredient",
"description": "Returns medications for this ingredient reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Returns medications made or sold for this manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Medication operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Medication/{id}/_history/{vid}": {
"get": {
"tags": [
"Medication"
],
"summary": "Read specific version of a Medication resource",
"operationId": "vreadMedication",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Medication operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Medication"
}
}
}
}
}
}
},
"/Medication/{id}": {
"get": {
"tags": [
"Medication"
],
"summary": "Read a Medication resource",
"operationId": "readMedication",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Medication operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Medication"
}
}
}
}
}
},
"put": {
"tags": [
"Medication"
],
"summary": "Update an existing Medication resource",
"operationId": "updateMedication",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Medication operation successful"
},
"201": {
"description": "Create Medication operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Medication"
}
},
"delete": {
"tags": [
"Medication"
],
"summary": "Delete a Medication resource",
"operationId": "deleteMedication",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Medication operation successful"
}
}
}
},
"/Medication/{id}/_history": {
"get": {
"tags": [
"Medication"
],
"summary": "Return the history of a Medication resource",
"operationId": "historyMedication",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Medication operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Medication/_history": {
"get": {
"tags": [
"Medication"
],
"summary": "Get the whole system history for Medication resources",
"operationId": "wholeSystemHistoryMedication",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationAdministration": {
"post": {
"tags": [
"MedicationAdministration"
],
"summary": "Create a MedicationAdministration resource",
"operationId": "createMedicationAdministration",
"responses": {
"201": {
"description": "Create MedicationAdministration operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationAdministration"
}
},
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources",
"operationId": "searchMedicationAdministration",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationAdministration/_search": {
"post": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources",
"operationId": "searchViaPostMedicationAdministration",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationAdministration/{id}/_history/{vid}": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Read specific version of a MedicationAdministration resource",
"operationId": "vreadMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationAdministration"
}
}
}
}
}
}
},
"/MedicationAdministration/{id}": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Read a MedicationAdministration resource",
"operationId": "readMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationAdministration"
}
}
}
}
}
},
"put": {
"tags": [
"MedicationAdministration"
],
"summary": "Update an existing MedicationAdministration resource",
"operationId": "updateMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update MedicationAdministration operation successful"
},
"201": {
"description": "Create MedicationAdministration operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationAdministration"
}
},
"delete": {
"tags": [
"MedicationAdministration"
],
"summary": "Delete a MedicationAdministration resource",
"operationId": "deleteMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete MedicationAdministration operation successful"
}
}
}
},
"/MedicationAdministration/{id}/_history": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Return the history of a MedicationAdministration resource",
"operationId": "historyMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationAdministration/_history": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Get the whole system history for MedicationAdministration resources",
"operationId": "wholeSystemHistoryMedicationAdministration",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationDispense": {
"post": {
"tags": [
"MedicationDispense"
],
"summary": "Create a MedicationDispense resource",
"operationId": "createMedicationDispense",
"responses": {
"201": {
"description": "Create MedicationDispense operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationDispense"
}
},
"get": {
"tags": [
"MedicationDispense"
],
"summary": "Search for MedicationDispense resources",
"operationId": "searchMedicationDispense",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "whenprepared",
"description": "Returns dispenses prepared on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "whenhandedover",
"description": "Returns dispenses handed over on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Returns dispenses of a specific type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "destination",
"description": "Returns dispenses that should be sent to a specific destination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "responsibleparty",
"description": "Returns dispenses with the specified responsible party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "prescription",
"description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"description": "The identity of a receiver to list dispenses for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient for whom to list dispenses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Returns dispenses performed by a specific individual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns dispenses with a specific context (episode or episode of care)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationDispense/_search": {
"post": {
"tags": [
"MedicationDispense"
],
"summary": "Search for MedicationDispense resources",
"operationId": "searchViaPostMedicationDispense",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "whenprepared",
"description": "Returns dispenses prepared on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "whenhandedover",
"description": "Returns dispenses handed over on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Returns dispenses of a specific type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "destination",
"description": "Returns dispenses that should be sent to a specific destination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "responsibleparty",
"description": "Returns dispenses with the specified responsible party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "prescription",
"description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"description": "The identity of a receiver to list dispenses for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient for whom to list dispenses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Returns dispenses performed by a specific individual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns dispenses with a specific context (episode or episode of care)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationDispense/{id}/_history/{vid}": {
"get": {
"tags": [
"MedicationDispense"
],
"summary": "Read specific version of a MedicationDispense resource",
"operationId": "vreadMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationDispense"
}
}
}
}
}
}
},
"/MedicationDispense/{id}": {
"get": {
"tags": [
"MedicationDispense"
],
"summary": "Read a MedicationDispense resource",
"operationId": "readMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationDispense"
}
}
}
}
}
},
"put": {
"tags": [
"MedicationDispense"
],
"summary": "Update an existing MedicationDispense resource",
"operationId": "updateMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update MedicationDispense operation successful"
},
"201": {
"description": "Create MedicationDispense operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationDispense"
}
},
"delete": {
"tags": [
"MedicationDispense"
],
"summary": "Delete a MedicationDispense resource",
"operationId": "deleteMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete MedicationDispense operation successful"
}
}
}
},
"/MedicationDispense/{id}/_history": {
"get": {
"tags": [
"MedicationDispense"
],
"summary": "Return the history of a MedicationDispense resource",
"operationId": "historyMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationDispense/_history": {
"get": {
"tags": [
"MedicationDispense"
],
"summary": "Get the whole system history for MedicationDispense resources",
"operationId": "wholeSystemHistoryMedicationDispense",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationRequest": {
"post": {
"tags": [
"MedicationRequest"
],
"summary": "Create a MedicationRequest resource",
"operationId": "createMedicationRequest",
"responses": {
"201": {
"description": "Create MedicationRequest operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationRequest"
}
},
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources",
"operationId": "searchMedicationRequest",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationRequest/_search": {
"post": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources",
"operationId": "searchViaPostMedicationRequest",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationRequest/{id}/_history/{vid}": {
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Read specific version of a MedicationRequest resource",
"operationId": "vreadMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationRequest"
}
}
}
}
}
}
},
"/MedicationRequest/{id}": {
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Read a MedicationRequest resource",
"operationId": "readMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationRequest"
}
}
}
}
}
},
"put": {
"tags": [
"MedicationRequest"
],
"summary": "Update an existing MedicationRequest resource",
"operationId": "updateMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update MedicationRequest operation successful"
},
"201": {
"description": "Create MedicationRequest operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationRequest"
}
},
"delete": {
"tags": [
"MedicationRequest"
],
"summary": "Delete a MedicationRequest resource",
"operationId": "deleteMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete MedicationRequest operation successful"
}
}
}
},
"/MedicationRequest/{id}/_history": {
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Return the history of a MedicationRequest resource",
"operationId": "historyMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationRequest/_history": {
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Get the whole system history for MedicationRequest resources",
"operationId": "wholeSystemHistoryMedicationRequest",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationStatement": {
"post": {
"tags": [
"MedicationStatement"
],
"summary": "Create a MedicationStatement resource",
"operationId": "createMedicationStatement",
"responses": {
"201": {
"description": "Create MedicationStatement operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationStatement"
}
},
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources",
"operationId": "searchMedicationStatement",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationStatement/_search": {
"post": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources",
"operationId": "searchViaPostMedicationStatement",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationStatement/{id}/_history/{vid}": {
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Read specific version of a MedicationStatement resource",
"operationId": "vreadMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationStatement"
}
}
}
}
}
}
},
"/MedicationStatement/{id}": {
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Read a MedicationStatement resource",
"operationId": "readMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationStatement"
}
}
}
}
}
},
"put": {
"tags": [
"MedicationStatement"
],
"summary": "Update an existing MedicationStatement resource",
"operationId": "updateMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update MedicationStatement operation successful"
},
"201": {
"description": "Create MedicationStatement operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/MedicationStatement"
}
},
"delete": {
"tags": [
"MedicationStatement"
],
"summary": "Delete a MedicationStatement resource",
"operationId": "deleteMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete MedicationStatement operation successful"
}
}
}
},
"/MedicationStatement/{id}/_history": {
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Return the history of a MedicationStatement resource",
"operationId": "historyMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/MedicationStatement/_history": {
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Get the whole system history for MedicationStatement resources",
"operationId": "wholeSystemHistoryMedicationStatement",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Observation": {
"post": {
"tags": [
"Observation"
],
"summary": "Create an Observation resource",
"operationId": "createObservation",
"responses": {
"201": {
"description": "Create Observation operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Observation"
}
},
"get": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources",
"operationId": "searchObservation",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Observation/_search": {
"post": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources",
"operationId": "searchViaPostObservation",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Observation/{id}/_history/{vid}": {
"get": {
"tags": [
"Observation"
],
"summary": "Read specific version of an Observation resource",
"operationId": "vreadObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Observation"
}
}
}
}
}
}
},
"/Observation/{id}": {
"get": {
"tags": [
"Observation"
],
"summary": "Read an Observation resource",
"operationId": "readObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Observation"
}
}
}
}
}
},
"put": {
"tags": [
"Observation"
],
"summary": "Update an existing Observation resource",
"operationId": "updateObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Observation operation successful"
},
"201": {
"description": "Create Observation operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Observation"
}
},
"delete": {
"tags": [
"Observation"
],
"summary": "Delete an Observation resource",
"operationId": "deleteObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Observation operation successful"
}
}
}
},
"/Observation/{id}/_history": {
"get": {
"tags": [
"Observation"
],
"summary": "Return the history of an Observation resource",
"operationId": "historyObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Observation/_history": {
"get": {
"tags": [
"Observation"
],
"summary": "Get the whole system history for Observation resources",
"operationId": "wholeSystemHistoryObservation",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Organization": {
"post": {
"tags": [
"Organization"
],
"summary": "Create an Organization resource",
"operationId": "createOrganization",
"responses": {
"201": {
"description": "Create Organization operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Organization"
}
},
"get": {
"tags": [
"Organization"
],
"summary": "Search for Organization resources",
"operationId": "searchOrganization",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "address-state",
"description": "A state specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "A country specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "A postal code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"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",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "A city specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A portion of the organization's name or alias",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "A portion of the organization's name using some kind of phonetic matching algorithm",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "A use code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "A code for the type of organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Is the Organization record active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Any identifier for the organization (not the accreditation issuer's identifier)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partof",
"description": "An organization of which this organization forms a part",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Organization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Organization/_search": {
"post": {
"tags": [
"Organization"
],
"summary": "Search for Organization resources",
"operationId": "searchViaPostOrganization",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "address-state",
"description": "A state specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "A country specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "A postal code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"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",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "A city specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A portion of the organization's name or alias",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "A portion of the organization's name using some kind of phonetic matching algorithm",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "A use code specified in an address",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "A code for the type of organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Is the Organization record active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Any identifier for the organization (not the accreditation issuer's identifier)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partof",
"description": "An organization of which this organization forms a part",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Organization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Organization/{id}/_history/{vid}": {
"get": {
"tags": [
"Organization"
],
"summary": "Read specific version of an Organization resource",
"operationId": "vreadOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Organization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
}
}
}
}
},
"/Organization/{id}": {
"get": {
"tags": [
"Organization"
],
"summary": "Read an Organization resource",
"operationId": "readOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Organization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
}
}
}
},
"put": {
"tags": [
"Organization"
],
"summary": "Update an existing Organization resource",
"operationId": "updateOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Organization operation successful"
},
"201": {
"description": "Create Organization operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Organization"
}
},
"delete": {
"tags": [
"Organization"
],
"summary": "Delete an Organization resource",
"operationId": "deleteOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Organization operation successful"
}
}
}
},
"/Organization/{id}/_history": {
"get": {
"tags": [
"Organization"
],
"summary": "Return the history of an Organization resource",
"operationId": "historyOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Organization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Organization/_history": {
"get": {
"tags": [
"Organization"
],
"summary": "Get the whole system history for Organization resources",
"operationId": "wholeSystemHistoryOrganization",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient": {
"post": {
"tags": [
"Patient"
],
"summary": "Create a Patient resource",
"operationId": "createPatient",
"responses": {
"201": {
"description": "Create Patient operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Patient"
}
},
"get": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources",
"operationId": "searchPatient",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/_search": {
"post": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources",
"operationId": "searchViaPostPatient",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/_history/{vid}": {
"get": {
"tags": [
"Patient"
],
"summary": "Read specific version of a Patient resource",
"operationId": "vreadPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Patient"
}
}
}
}
}
}
},
"/Patient/{id}": {
"get": {
"tags": [
"Patient"
],
"summary": "Read a Patient resource",
"operationId": "readPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Patient"
}
}
}
}
}
},
"put": {
"tags": [
"Patient"
],
"summary": "Update an existing Patient resource",
"operationId": "updatePatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Patient operation successful"
},
"201": {
"description": "Create Patient operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Patient"
}
},
"delete": {
"tags": [
"Patient"
],
"summary": "Delete a Patient resource",
"operationId": "deletePatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Patient operation successful"
}
}
}
},
"/Patient/{id}/_history": {
"get": {
"tags": [
"Patient"
],
"summary": "Return the history of a Patient resource",
"operationId": "historyPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/_history": {
"get": {
"tags": [
"Patient"
],
"summary": "Get the whole system history for Patient resources",
"operationId": "wholeSystemHistoryPatient",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/$export": {
"get": {
"tags": [
"Patient"
],
"summary": "Export Patient data from the FHIR server",
"operationId": "getExportPatient",
"parameters": [
{
"$ref": "#/components/parameters/_outputFormatParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_typeParam"
}
],
"responses": {
"202": {
"description": "Export job is initiated",
"headers": {
"Content-Location": {
"description": "The polling location",
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"tags": [
"Patient"
],
"summary": "Export Patient data from the FHIR server",
"operationId": "postExportPatient",
"requestBody": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Parameters"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Export job is initiated",
"headers": {
"Content-Location": {
"description": "The polling location",
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/Patient/$everything": {
"get": {
"tags": [
"Patient"
],
"summary": "Return all the information related to one or more patients",
"operationId": "everythingAllPatients",
"parameters": [
{
"name": "start",
"description": "All records relating to care provided in a certain date range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "end",
"description": "All records relating to care provided in a certain date range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "_type",
"description": "Limit which resource types are returned",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
},
"description": "everything operation successful"
}
}
}
},
"/Patient/{id}/$everything": {
"get": {
"tags": [
"Patient"
],
"summary": "Return all the information related to a given patient",
"operationId": "everythingPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "start",
"description": "All records relating to care provided in a certain date range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "end",
"description": "All records relating to care provided in a certain date range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "_type",
"description": "Limit which resource types are returned",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
},
"description": "everything operation successful"
}
}
}
},
"/Patient/{id}/Provenance": {
"get": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within Patient compartment",
"operationId": "searchPatientCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Provenance/_search": {
"post": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/ExplanationOfBenefit": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Patient compartment",
"operationId": "searchPatientCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/ExplanationOfBenefit/_search": {
"post": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/AllergyIntolerance": {
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources within Patient compartment",
"operationId": "searchPatientCompartmentAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/AllergyIntolerance/_search": {
"post": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/CarePlan": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within Patient compartment",
"operationId": "searchPatientCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/CarePlan/_search": {
"post": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Goal": {
"get": {
"tags": [
"Goal"
],
"summary": "Search for Goal resources within Patient compartment",
"operationId": "searchPatientCompartmentGoal",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "target-date",
"description": "Reach goal on or before",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "start-date",
"description": "When goal pursuit begins",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "E.g. Treatment, dietary, behavioral, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "achievement-status",
"description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycle-status",
"description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who this goal is intended for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Goal operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Goal/_search": {
"post": {
"tags": [
"Goal"
],
"summary": "Search for Goal resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentGoal",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "target-date",
"description": "Reach goal on or before",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "start-date",
"description": "When goal pursuit begins",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "E.g. Treatment, dietary, behavioral, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "achievement-status",
"description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycle-status",
"description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who this goal is intended for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Goal operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Consent": {
"get": {
"tags": [
"Consent"
],
"summary": "Search for Consent resources within Patient compartment",
"operationId": "searchPatientCompartmentConsent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "period",
"description": "Timeframe for this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | proposed | active | rejected | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "scope",
"description": "Which of the four areas this resource covers (extensible)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the consent statement - for indexing/retrieval",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Security Labels that define affected resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "purpose",
"description": "Context of activities covered by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "action",
"description": "Actions controlled by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "Custodian of the consent",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data",
"description": "The actual data reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source-reference",
"description": "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "consentor",
"description": "Who is agreeing to the policy and rules",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actor",
"description": "Resource for the actor (or group, by role)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Consent operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Consent/_search": {
"post": {
"tags": [
"Consent"
],
"summary": "Search for Consent resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentConsent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "period",
"description": "Timeframe for this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | proposed | active | rejected | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "scope",
"description": "Which of the four areas this resource covers (extensible)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the consent statement - for indexing/retrieval",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Security Labels that define affected resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "purpose",
"description": "Context of activities covered by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "action",
"description": "Actions controlled by this rule",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "Custodian of the consent",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data",
"description": "The actual data reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source-reference",
"description": "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "consentor",
"description": "Who is agreeing to the policy and rules",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actor",
"description": "Resource for the actor (or group, by role)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Consent operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Procedure": {
"get": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within Patient compartment",
"operationId": "searchPatientCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Procedure/_search": {
"post": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/List": {
"get": {
"tags": [
"List"
],
"summary": "Search for List resources within Patient compartment",
"operationId": "searchPatientCompartmentList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/List/_search": {
"post": {
"tags": [
"List"
],
"summary": "Search for List resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/DocumentReference": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Patient compartment",
"operationId": "searchPatientCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/DocumentReference/_search": {
"post": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Immunization": {
"get": {
"tags": [
"Immunization"
],
"summary": "Search for Immunization resources within Patient compartment",
"operationId": "searchPatientCompartmentImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction-date",
"description": "When reaction started",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Vaccine Lot Number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "series",
"description": "The series being followed by the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Immunization event status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "vaccine-code",
"description": "Vaccine Product Administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target-disease",
"description": "The target disease the dose is being administered against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status-reason",
"description": "Reason why the vaccine was not administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Reason why the vaccine was administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction",
"description": "Additional information on reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Vaccine Manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The practitioner or organization who played a role in the vaccination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "The service delivery location or facility in which the vaccine was / was to be administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Why immunization occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Immunization/_search": {
"post": {
"tags": [
"Immunization"
],
"summary": "Search for Immunization resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction-date",
"description": "When reaction started",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Vaccine Lot Number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "series",
"description": "The series being followed by the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Immunization event status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "vaccine-code",
"description": "Vaccine Product Administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target-disease",
"description": "The target disease the dose is being administered against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status-reason",
"description": "Reason why the vaccine was not administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Reason why the vaccine was administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction",
"description": "Additional information on reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Vaccine Manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The practitioner or organization who played a role in the vaccination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "The service delivery location or facility in which the vaccine was / was to be administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Why immunization occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationRequest": {
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources within Patient compartment",
"operationId": "searchPatientCompartmentMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationRequest/_search": {
"post": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Observation": {
"get": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Patient compartment",
"operationId": "searchPatientCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Observation/_search": {
"post": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationAdministration": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Patient compartment",
"operationId": "searchPatientCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationAdministration/_search": {
"post": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationStatement": {
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources within Patient compartment",
"operationId": "searchPatientCompartmentMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationStatement/_search": {
"post": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Group": {
"get": {
"tags": [
"Group"
],
"summary": "Search for Group resources within Patient compartment",
"operationId": "searchPatientCompartmentGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Group/_search": {
"post": {
"tags": [
"Group"
],
"summary": "Search for Group resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/CareTeam": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within Patient compartment",
"operationId": "searchPatientCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/CareTeam/_search": {
"post": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationDispense": {
"get": {
"tags": [
"MedicationDispense"
],
"summary": "Search for MedicationDispense resources within Patient compartment",
"operationId": "searchPatientCompartmentMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "whenprepared",
"description": "Returns dispenses prepared on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "whenhandedover",
"description": "Returns dispenses handed over on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Returns dispenses of a specific type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "destination",
"description": "Returns dispenses that should be sent to a specific destination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "responsibleparty",
"description": "Returns dispenses with the specified responsible party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "prescription",
"description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"description": "The identity of a receiver to list dispenses for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient for whom to list dispenses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Returns dispenses performed by a specific individual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns dispenses with a specific context (episode or episode of care)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/MedicationDispense/_search": {
"post": {
"tags": [
"MedicationDispense"
],
"summary": "Search for MedicationDispense resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "whenprepared",
"description": "Returns dispenses prepared on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "whenhandedover",
"description": "Returns dispenses handed over on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Returns dispenses of a specific type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "destination",
"description": "Returns dispenses that should be sent to a specific destination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "responsibleparty",
"description": "Returns dispenses with the specified responsible party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "prescription",
"description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"description": "The identity of a receiver to list dispenses for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient for whom to list dispenses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Returns dispenses performed by a specific individual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns dispenses with a specific context (episode or episode of care)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/DiagnosticReport": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Patient compartment",
"operationId": "searchPatientCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/DiagnosticReport/_search": {
"post": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Encounter": {
"get": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within Patient compartment",
"operationId": "searchPatientCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Encounter/_search": {
"post": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Condition": {
"get": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within Patient compartment",
"operationId": "searchPatientCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Condition/_search": {
"post": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Patient": {
"get": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources within Patient compartment",
"operationId": "searchPatientCompartmentPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Patient/_search": {
"post": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Coverage": {
"get": {
"tags": [
"Coverage"
],
"summary": "Search for Coverage resources within Patient compartment",
"operationId": "searchPatientCompartmentCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "dependent",
"description": "Dependent number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-value",
"description": "Value of the class (eg. Plan number, group number)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the Coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The kind of coverage (health plan, auto, Workers Compensation)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-type",
"description": "Coverage class (eg. plan, group)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The primary identifier of the insured and the coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "beneficiary",
"description": "Covered party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Retrieve coverages for a patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payor",
"description": "The identity of the insurer or party paying for services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "policy-holder",
"description": "Reference to the policyholder",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subscriber",
"description": "Reference to the subscriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Patient/{id}/Coverage/_search": {
"post": {
"tags": [
"Coverage"
],
"summary": "Search for Coverage resources within Patient compartment",
"operationId": "searchViaPostPatientCompartmentCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "dependent",
"description": "Dependent number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-value",
"description": "Value of the class (eg. Plan number, group number)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the Coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The kind of coverage (health plan, auto, Workers Compensation)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-type",
"description": "Coverage class (eg. plan, group)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The primary identifier of the insured and the coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "beneficiary",
"description": "Covered party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Retrieve coverages for a patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payor",
"description": "The identity of the insurer or party paying for services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "policy-holder",
"description": "Reference to the policyholder",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subscriber",
"description": "Reference to the subscriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner": {
"post": {
"tags": [
"Practitioner"
],
"summary": "Create a Practitioner resource",
"operationId": "createPractitioner",
"responses": {
"201": {
"description": "Create Practitioner operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Practitioner"
}
},
"get": {
"tags": [
"Practitioner"
],
"summary": "Search for Practitioner resources",
"operationId": "searchPractitioner",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "communication",
"description": "One of the languages that the practitioner can communicate with",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the practitioner record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Practitioner operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/_search": {
"post": {
"tags": [
"Practitioner"
],
"summary": "Search for Practitioner resources",
"operationId": "searchViaPostPractitioner",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "communication",
"description": "One of the languages that the practitioner can communicate with",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the practitioner record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Practitioner operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/_history/{vid}": {
"get": {
"tags": [
"Practitioner"
],
"summary": "Read specific version of a Practitioner resource",
"operationId": "vreadPractitioner",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Practitioner operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Practitioner"
}
}
}
}
}
}
},
"/Practitioner/{id}": {
"get": {
"tags": [
"Practitioner"
],
"summary": "Read a Practitioner resource",
"operationId": "readPractitioner",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Practitioner operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Practitioner"
}
}
}
}
}
},
"put": {
"tags": [
"Practitioner"
],
"summary": "Update an existing Practitioner resource",
"operationId": "updatePractitioner",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Practitioner operation successful"
},
"201": {
"description": "Create Practitioner operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Practitioner"
}
},
"delete": {
"tags": [
"Practitioner"
],
"summary": "Delete a Practitioner resource",
"operationId": "deletePractitioner",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Practitioner operation successful"
}
}
}
},
"/Practitioner/{id}/_history": {
"get": {
"tags": [
"Practitioner"
],
"summary": "Return the history of a Practitioner resource",
"operationId": "historyPractitioner",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Practitioner operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/_history": {
"get": {
"tags": [
"Practitioner"
],
"summary": "Get the whole system history for Practitioner resources",
"operationId": "wholeSystemHistoryPractitioner",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Provenance": {
"get": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Provenance/_search": {
"post": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/ExplanationOfBenefit": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/ExplanationOfBenefit/_search": {
"post": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/AllergyIntolerance": {
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/AllergyIntolerance/_search": {
"post": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/CarePlan": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/CarePlan/_search": {
"post": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Procedure": {
"get": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Procedure/_search": {
"post": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/List": {
"get": {
"tags": [
"List"
],
"summary": "Search for List resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/List/_search": {
"post": {
"tags": [
"List"
],
"summary": "Search for List resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentList",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Descriptive name for the list",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notes",
"description": "The annotation - text content (as markdown)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "empty-reason",
"description": "Why list is empty",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | retired | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item",
"description": "Actual entry",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who and/or what defined the list contents (aka Author)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "If all resources have the same subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search List operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/DocumentReference": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/DocumentReference/_search": {
"post": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Immunization": {
"get": {
"tags": [
"Immunization"
],
"summary": "Search for Immunization resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction-date",
"description": "When reaction started",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Vaccine Lot Number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "series",
"description": "The series being followed by the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Immunization event status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "vaccine-code",
"description": "Vaccine Product Administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target-disease",
"description": "The target disease the dose is being administered against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status-reason",
"description": "Reason why the vaccine was not administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Reason why the vaccine was administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction",
"description": "Additional information on reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Vaccine Manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The practitioner or organization who played a role in the vaccination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "The service delivery location or facility in which the vaccine was / was to be administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Why immunization occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Immunization/_search": {
"post": {
"tags": [
"Immunization"
],
"summary": "Search for Immunization resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentImmunization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction-date",
"description": "When reaction started",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lot-number",
"description": "Vaccine Lot Number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "series",
"description": "The series being followed by the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Immunization event status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "vaccine-code",
"description": "Vaccine Product Administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target-disease",
"description": "The target disease the dose is being administered against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status-reason",
"description": "Reason why the vaccine was not administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Reason why the vaccine was administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reaction",
"description": "Additional information on reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manufacturer",
"description": "Vaccine Manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The practitioner or organization who played a role in the vaccination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "The service delivery location or facility in which the vaccine was / was to be administered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Why immunization occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Immunization operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationRequest": {
"get": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationRequest/_search": {
"post": {
"tags": [
"MedicationRequest"
],
"summary": "Search for MedicationRequest resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentMedicationRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authoredon",
"description": "Return prescriptions written on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns prescriptions with different categories",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "priority",
"description": "Returns prescriptions with different priorities",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "Returns prescriptions with different intents",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performertype",
"description": "Returns requests for a specific type of performer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient to list orders for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requester",
"description": "Returns prescriptions prescribed by this prescriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-performer",
"description": "Returns the intended performer of the administration of the medication request",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intended-dispenser",
"description": "Returns prescriptions intended to be dispensed by this Organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationRequest operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/PractitionerRole": {
"get": {
"tags": [
"PractitionerRole"
],
"summary": "Search for PractitionerRole resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentPractitionerRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "The period during which the practitioner is authorized to perform in these role(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specialty",
"description": "The practitioner has this specialty at an organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether this practitioner role record is in active use",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "role",
"description": "The practitioner can perform this role at for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "One of the locations at which this practitioner provides care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The identity of the organization the practitioner represents / acts on behalf of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the practitioner with this role",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service",
"description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Practitioner that is able to provide the defined services for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search PractitionerRole operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/PractitionerRole/_search": {
"post": {
"tags": [
"PractitionerRole"
],
"summary": "Search for PractitionerRole resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentPractitionerRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "The period during which the practitioner is authorized to perform in these role(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specialty",
"description": "The practitioner has this specialty at an organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether this practitioner role record is in active use",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "role",
"description": "The practitioner can perform this role at for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "One of the locations at which this practitioner provides care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The identity of the organization the practitioner represents / acts on behalf of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the practitioner with this role",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service",
"description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Practitioner that is able to provide the defined services for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search PractitionerRole operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Practitioner": {
"get": {
"tags": [
"Practitioner"
],
"summary": "Search for Practitioner resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentPractitioner",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "communication",
"description": "One of the languages that the practitioner can communicate with",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the practitioner record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Practitioner operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Practitioner/_search": {
"post": {
"tags": [
"Practitioner"
],
"summary": "Search for Practitioner resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentPractitioner",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "communication",
"description": "One of the languages that the practitioner can communicate with",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the practitioner record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Practitioner operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Observation": {
"get": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Observation/_search": {
"post": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationAdministration": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationAdministration/_search": {
"post": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationStatement": {
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationStatement/_search": {
"post": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Group": {
"get": {
"tags": [
"Group"
],
"summary": "Search for Group resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Group/_search": {
"post": {
"tags": [
"Group"
],
"summary": "Search for Group resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "code",
"description": "The kind of resources contained",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "actual",
"description": "Descriptive or actual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude",
"description": "Group includes or excludes",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value",
"description": "Value held by characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of resources the group contains",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Unique id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic",
"description": "Kind of characteristic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managing-entity",
"description": "Entity that is the custodian of the Group's definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "member",
"description": "Reference to the group member",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "characteristic-value",
"description": "A composite of both characteristic and value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Group operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/CareTeam": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/CareTeam/_search": {
"post": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationDispense": {
"get": {
"tags": [
"MedicationDispense"
],
"summary": "Search for MedicationDispense resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "whenprepared",
"description": "Returns dispenses prepared on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "whenhandedover",
"description": "Returns dispenses handed over on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Returns dispenses of a specific type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "destination",
"description": "Returns dispenses that should be sent to a specific destination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "responsibleparty",
"description": "Returns dispenses with the specified responsible party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "prescription",
"description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"description": "The identity of a receiver to list dispenses for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient for whom to list dispenses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Returns dispenses performed by a specific individual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns dispenses with a specific context (episode or episode of care)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/MedicationDispense/_search": {
"post": {
"tags": [
"MedicationDispense"
],
"summary": "Search for MedicationDispense resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentMedicationDispense",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "whenprepared",
"description": "Returns dispenses prepared on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "whenhandedover",
"description": "Returns dispenses handed over on this date",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Returns dispenses of a specific type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "destination",
"description": "Returns dispenses that should be sent to a specific destination",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "responsibleparty",
"description": "Returns dispenses with the specified responsible party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "prescription",
"description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"description": "The identity of a receiver to list dispenses for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient for whom to list dispenses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Returns dispenses performed by a specific individual",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns dispenses with a specific context (episode or episode of care)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationDispense operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/DiagnosticReport": {
"get": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/DiagnosticReport/_search": {
"post": {
"tags": [
"DiagnosticReport"
],
"summary": "Search for DiagnosticReport resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentDiagnosticReport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "issued",
"description": "When the report was issued",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conclusion",
"description": "A coded conclusion (interpretation/impression) on the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Which diagnostic discipline/department created the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "result",
"description": "Link to an atomic result (observation resource)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "The specimen details",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "results-interpreter",
"description": "Who was the source of the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "media",
"description": "A reference to the image source.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who is responsible for the report",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DiagnosticReport operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Encounter": {
"get": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Encounter/_search": {
"post": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Condition": {
"get": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Condition/_search": {
"post": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Patient": {
"get": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources within Practitioner compartment",
"operationId": "searchPractitionerCompartmentPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Practitioner/{id}/Patient/_search": {
"post": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources within Practitioner compartment",
"operationId": "searchViaPostPractitionerCompartmentPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/PractitionerRole": {
"post": {
"tags": [
"PractitionerRole"
],
"summary": "Create a PractitionerRole resource",
"operationId": "createPractitionerRole",
"responses": {
"201": {
"description": "Create PractitionerRole operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/PractitionerRole"
}
},
"get": {
"tags": [
"PractitionerRole"
],
"summary": "Search for PractitionerRole resources",
"operationId": "searchPractitionerRole",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "The period during which the practitioner is authorized to perform in these role(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specialty",
"description": "The practitioner has this specialty at an organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether this practitioner role record is in active use",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "role",
"description": "The practitioner can perform this role at for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "One of the locations at which this practitioner provides care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The identity of the organization the practitioner represents / acts on behalf of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the practitioner with this role",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service",
"description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Practitioner that is able to provide the defined services for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search PractitionerRole operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/PractitionerRole/_search": {
"post": {
"tags": [
"PractitionerRole"
],
"summary": "Search for PractitionerRole resources",
"operationId": "searchViaPostPractitionerRole",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "The period during which the practitioner is authorized to perform in these role(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specialty",
"description": "The practitioner has this specialty at an organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether this practitioner role record is in active use",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "role",
"description": "The practitioner can perform this role at for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A practitioner's Identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "One of the locations at which this practitioner provides care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The identity of the organization the practitioner represents / acts on behalf of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint",
"description": "Technical endpoints providing access to services operated for the practitioner with this role",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service",
"description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Practitioner that is able to provide the defined services for the organization",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search PractitionerRole operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/PractitionerRole/{id}/_history/{vid}": {
"get": {
"tags": [
"PractitionerRole"
],
"summary": "Read specific version of a PractitionerRole resource",
"operationId": "vreadPractitionerRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read PractitionerRole operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/PractitionerRole"
}
}
}
}
}
}
},
"/PractitionerRole/{id}": {
"get": {
"tags": [
"PractitionerRole"
],
"summary": "Read a PractitionerRole resource",
"operationId": "readPractitionerRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read PractitionerRole operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/PractitionerRole"
}
}
}
}
}
},
"put": {
"tags": [
"PractitionerRole"
],
"summary": "Update an existing PractitionerRole resource",
"operationId": "updatePractitionerRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update PractitionerRole operation successful"
},
"201": {
"description": "Create PractitionerRole operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/PractitionerRole"
}
},
"delete": {
"tags": [
"PractitionerRole"
],
"summary": "Delete a PractitionerRole resource",
"operationId": "deletePractitionerRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete PractitionerRole operation successful"
}
}
}
},
"/PractitionerRole/{id}/_history": {
"get": {
"tags": [
"PractitionerRole"
],
"summary": "Return the history of a PractitionerRole resource",
"operationId": "historyPractitionerRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History PractitionerRole operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/PractitionerRole/_history": {
"get": {
"tags": [
"PractitionerRole"
],
"summary": "Get the whole system history for PractitionerRole resources",
"operationId": "wholeSystemHistoryPractitionerRole",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Procedure": {
"post": {
"tags": [
"Procedure"
],
"summary": "Create a Procedure resource",
"operationId": "createProcedure",
"responses": {
"201": {
"description": "Create Procedure operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Procedure"
}
},
"get": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources",
"operationId": "searchProcedure",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Procedure/_search": {
"post": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources",
"operationId": "searchViaPostProcedure",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Procedure/{id}/_history/{vid}": {
"get": {
"tags": [
"Procedure"
],
"summary": "Read specific version of a Procedure resource",
"operationId": "vreadProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Procedure"
}
}
}
}
}
}
},
"/Procedure/{id}": {
"get": {
"tags": [
"Procedure"
],
"summary": "Read a Procedure resource",
"operationId": "readProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Procedure"
}
}
}
}
}
},
"put": {
"tags": [
"Procedure"
],
"summary": "Update an existing Procedure resource",
"operationId": "updateProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Procedure operation successful"
},
"201": {
"description": "Create Procedure operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Procedure"
}
},
"delete": {
"tags": [
"Procedure"
],
"summary": "Delete a Procedure resource",
"operationId": "deleteProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Procedure operation successful"
}
}
}
},
"/Procedure/{id}/_history": {
"get": {
"tags": [
"Procedure"
],
"summary": "Return the history of a Procedure resource",
"operationId": "historyProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Procedure/_history": {
"get": {
"tags": [
"Procedure"
],
"summary": "Get the whole system history for Procedure resources",
"operationId": "wholeSystemHistoryProcedure",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Provenance": {
"post": {
"tags": [
"Provenance"
],
"summary": "Create a Provenance resource",
"operationId": "createProvenance",
"responses": {
"201": {
"description": "Create Provenance operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Provenance"
}
},
"get": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources",
"operationId": "searchProvenance",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Provenance/_search": {
"post": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources",
"operationId": "searchViaPostProvenance",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Provenance/{id}/_history/{vid}": {
"get": {
"tags": [
"Provenance"
],
"summary": "Read specific version of a Provenance resource",
"operationId": "vreadProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Provenance"
}
}
}
}
}
}
},
"/Provenance/{id}": {
"get": {
"tags": [
"Provenance"
],
"summary": "Read a Provenance resource",
"operationId": "readProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Provenance"
}
}
}
}
}
},
"put": {
"tags": [
"Provenance"
],
"summary": "Update an existing Provenance resource",
"operationId": "updateProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update Provenance operation successful"
},
"201": {
"description": "Create Provenance operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Provenance"
}
},
"delete": {
"tags": [
"Provenance"
],
"summary": "Delete a Provenance resource",
"operationId": "deleteProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete Provenance operation successful"
}
}
}
},
"/Provenance/{id}/_history": {
"get": {
"tags": [
"Provenance"
],
"summary": "Return the history of a Provenance resource",
"operationId": "historyProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/Provenance/_history": {
"get": {
"tags": [
"Provenance"
],
"summary": "Get the whole system history for Provenance resources",
"operationId": "wholeSystemHistoryProvenance",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Provenance": {
"get": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Provenance/_search": {
"post": {
"tags": [
"Provenance"
],
"summary": "Search for Provenance resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentProvenance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "when",
"description": "When the activity occurred",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorded",
"description": "When the activity was recorded / updated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "signature-type",
"description": "Indication of the reason the entity signed the object(s)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-role",
"description": "What the agents role was",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent-type",
"description": "How the agent participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"description": "Identity of entity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the activity occurred, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "target",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Target Reference(s) (usually version specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "agent",
"description": "Who participated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Provenance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/CareTeam": {
"get": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/CareTeam/_search": {
"post": {
"tags": [
"CareTeam"
],
"summary": "Search for CareTeam resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentCareTeam",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "proposed | active | suspended | inactive | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who care team is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Who is involved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CareTeam operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/ExplanationOfBenefit": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/ExplanationOfBenefit/_search": {
"post": {
"tags": [
"ExplanationOfBenefit"
],
"summary": "Search for ExplanationOfBenefit resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentExplanationOfBenefit",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "created",
"description": "The creation date for the EOB",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "disposition",
"description": "The contents of the disposition message",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Status of the instance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The business identifier of the Explanation of Benefit",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Member of the CareTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "The reference to the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payee",
"description": "The party receiving any payment for the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Facility responsible for the goods and services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "claim",
"description": "The reference to the claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "procedure-udi",
"description": "UDI associated with a procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounters associated with a billed line item",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subdetail-udi",
"description": "UDI associated with a line item detail subdetail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "coverage",
"description": "The plan under which the claim was adjudicated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item-udi",
"description": "UDI associated with a line item product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "detail-udi",
"description": "UDI associated with a line item detail product or service",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "enterer",
"description": "The party responsible for the entry of the Claim",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"description": "The reference to the provider",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search ExplanationOfBenefit operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/AllergyIntolerance": {
"get": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/AllergyIntolerance/_search": {
"post": {
"tags": [
"AllergyIntolerance"
],
"summary": "Search for AllergyIntolerance resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentAllergyIntolerance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "onset",
"description": "Date(/time) when manifestations showed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last-date",
"description": "Date(/time) of last known occurrence of a reaction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "active | inactive | resolved",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "food | medication | environment | biologic",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "route",
"description": "How the subject was exposed to the substance",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criticality",
"description": "low | high | unable-to-assess",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "mild | moderate | severe (of event as a whole)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manifestation",
"description": "Clinical symptoms/signs associated with the Event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "recorder",
"description": "Who recorded the sensitivity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Source of the information about the allergy",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search AllergyIntolerance operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/CarePlan": {
"get": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/CarePlan/_search": {
"post": {
"tags": [
"CarePlan"
],
"summary": "Search for CarePlan resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentCarePlan",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "activity-date",
"description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-code",
"description": "Detail type of activity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "intent",
"description": "proposal | plan | order | option",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Type of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who the care plan is for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "goal",
"description": "Desired outcome of plan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "replaces",
"description": "CarePlan replaced by this CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Fulfills CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "care-team",
"description": "Who's involved in plan?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "activity-reference",
"description": "Activity details defined in specific resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced CarePlan",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"description": "Health issues this plan addresses",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search CarePlan operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Encounter": {
"get": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Encounter/_search": {
"post": {
"tags": [
"Encounter"
],
"summary": "Search for Encounter resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentEncounter",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "location-period",
"description": "Time period during which the patient was present at the location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant-type",
"description": "Role of participant in encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class",
"description": "Classification of patient encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "special-arrangement",
"description": "Wheelchair, translator, stretcher, etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "Reason the encounter takes place (reference)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Another Encounter this encounter is part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "episode-of-care",
"description": "Episode(s) of care that this encounter should be recorded against",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Location the encounter takes place",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "account",
"description": "The set of accounts that may be used for billing for this Encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The patient or group present at the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appointment",
"description": "The appointment that scheduled this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "service-provider",
"description": "The organization (facility) responsible for this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "The ServiceRequest that initiated this encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "participant",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "diagnosis",
"description": "The diagnosis or procedure relevant to the encounter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "practitioner",
"description": "Persons involved in the encounter other than the patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "length",
"description": "Length of encounter in days",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Encounter operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Procedure": {
"get": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Procedure/_search": {
"post": {
"tags": [
"Procedure"
],
"summary": "Search for Procedure resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentProcedure",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-code",
"description": "Coded reason procedure performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Classification of the procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-reference",
"description": "The justification that the procedure was performed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The reference to the practitioner",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Search by subject",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "A request for this procedure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-canonical",
"description": "Instantiates FHIR protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Where the procedure happened",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "instantiates-uri",
"description": "Instantiates external protocol or definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Procedure operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/DocumentReference": {
"get": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/DocumentReference/_search": {
"post": {
"tags": [
"DocumentReference"
],
"summary": "Search for DocumentReference resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentDocumentReference",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "period",
"description": "Time of service that is being documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "When this document reference was created",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Human-readable description",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Categorization of document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facility",
"description": "Kind of facility where patient was seen",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relation",
"description": "replaces | transforms | signs | appends",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contenttype",
"description": "Mime type of the content, with charset etc.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "security-label",
"description": "Document security-tags",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "event",
"description": "Main clinical acts documented",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "format",
"description": "Format/content rules for the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "setting",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "current | superseded | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Human language of the content (BCP-47)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatesto",
"description": "Target of the relationship",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related",
"description": "Related identifiers or resources",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "author",
"description": "Who and/or what authored the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authenticator",
"description": "Who/what authenticated the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who/what is the subject of the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "custodian",
"description": "Organization which maintains the document",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationship",
"description": "Combination of relation and relatesTo",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "location",
"description": "Uri where the data can be found",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search DocumentReference operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Condition": {
"get": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Condition/_search": {
"post": {
"tags": [
"Condition"
],
"summary": "Search for Condition resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentCondition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "recorded-date",
"description": "Date record was first recorded",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-date",
"description": "Date-related abatements (dateTime and period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-date",
"description": "Date related onsets (dateTime and Period)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-string",
"description": "Abatement as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-info",
"description": "Onsets as a string",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clinical-status",
"description": "The clinical status of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The category of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"description": "Simple summary (disease specific)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "body-site",
"description": "Anatomical location, if relevant",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "severity",
"description": "The severity of the condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence",
"description": "Manifestation/symptom",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verification-status",
"description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "evidence-detail",
"description": "Supporting information found elsewhere",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "asserter",
"description": "Person who asserts this condition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "Who has the condition?",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Encounter created as part of",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abatement-age",
"description": "Abatement as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "onset-age",
"description": "Onsets as age or age range",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Condition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Patient": {
"get": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Patient/_search": {
"post": {
"tags": [
"Patient"
],
"summary": "Search for Patient resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentPatient",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "birthdate",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "death-date",
"description": "The date of death has been provided and satisfies this search value",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phonetic",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-country",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-city",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-state",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "given",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-postalcode",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "family",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "address-use",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "phone",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "active",
"description": "Whether the patient record is active",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "language",
"description": "Language code (irrespective of use value)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gender",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "telecom",
"description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deceased",
"description": "This patient has been marked as deceased, or as a death date entered",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "A patient identifier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organization",
"description": "The organization that is the custodian of the patient record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "link",
"description": "All patients linked to the given patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "general-practitioner",
"description": "Patient's nominated general practitioner, not the organization that manages the record",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Patient operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Coverage": {
"get": {
"tags": [
"Coverage"
],
"summary": "Search for Coverage resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "dependent",
"description": "Dependent number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-value",
"description": "Value of the class (eg. Plan number, group number)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the Coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The kind of coverage (health plan, auto, Workers Compensation)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-type",
"description": "Coverage class (eg. plan, group)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The primary identifier of the insured and the coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "beneficiary",
"description": "Covered party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Retrieve coverages for a patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payor",
"description": "The identity of the insurer or party paying for services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "policy-holder",
"description": "Reference to the policyholder",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subscriber",
"description": "Reference to the subscriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Coverage/_search": {
"post": {
"tags": [
"Coverage"
],
"summary": "Search for Coverage resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentCoverage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "dependent",
"description": "Dependent number",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-value",
"description": "Value of the class (eg. Plan number, group number)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the Coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The kind of coverage (health plan, auto, Workers Compensation)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "class-type",
"description": "Coverage class (eg. plan, group)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "The primary identifier of the insured and the coverage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "beneficiary",
"description": "Covered party",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Retrieve coverages for a patient",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payor",
"description": "The identity of the insurer or party paying for services",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "policy-holder",
"description": "Reference to the policyholder",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subscriber",
"description": "Reference to the subscriber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Coverage operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Observation": {
"get": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/Observation/_search": {
"post": {
"tags": [
"Observation"
],
"summary": "Search for Observation resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentObservation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "value-date",
"description": "The value of the observation, if the value is a date or period of time",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-string",
"description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The status of the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-data-absent-reason",
"description": "The reason why the expected value in the element Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-concept",
"description": "The value of the component observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-concept",
"description": "The value or component value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-concept",
"description": "The value of the observation, if the value is a CodeableConcept",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "method",
"description": "The method used for the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code",
"description": "The code of the observation type or component type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-data-absent-reason",
"description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code",
"description": "The component code of the observation type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "The classification of the type of observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "The Device that generated the observation data.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Part of referenced event",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "based-on",
"description": "Reference to the service request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "Who performed the observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "specimen",
"description": "Specimen used for this observation",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "encounter",
"description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived-from",
"description": "Related measurements the observation is made from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "focus",
"description": "The focus of an observation when the focus is not the patient of record.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "has-member",
"description": "Related resource that belongs to the Observation group",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The subject that the observation is about",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-concept",
"description": "Code and coded value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-concept",
"description": "Component code and component coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-concept",
"description": "Code and coded value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-quantity",
"description": "Code and quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-string",
"description": "Code and string value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-code-value-quantity",
"description": "Code and quantity value parameter pair, including in components",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code-value-date",
"description": "Code and date/time value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-code-value-quantity",
"description": "Component code and component quantity value parameter pair",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "combo-value-quantity",
"description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "value-quantity",
"description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "component-value-quantity",
"description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search Observation operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/MedicationAdministration": {
"get": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/MedicationAdministration/_search": {
"post": {
"tags": [
"MedicationAdministration"
],
"summary": "Search for MedicationAdministration resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective-time",
"description": "Date administration happened (or did not happen)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-given",
"description": "Reasons for administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reason-not-given",
"description": "Reasons for not administering the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Return administrations that share this encounter or episode of care",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of the individual or group to list administrations for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "request",
"description": "The identity of a request to list administrations from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device",
"description": "Return administrations with this administration device identity",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "performer",
"description": "The identity of the individual who administered the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationAdministration operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/MedicationStatement": {
"get": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources within RelatedPerson compartment",
"operationId": "searchRelatedPersonCompartmentMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/RelatedPerson/{id}/MedicationStatement/_search": {
"post": {
"tags": [
"MedicationStatement"
],
"summary": "Search for MedicationStatement resources within RelatedPerson compartment",
"operationId": "searchViaPostRelatedPersonCompartmentMedicationStatement",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "effective",
"description": "Date when patient was taking (or not taking) the medication",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"description": "Returns statements of this category of medicationstatement",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "source",
"description": "Who or where the information in the statement came from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "patient",
"description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "part-of",
"description": "Returns statements that are part of another event.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "medication",
"description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subject",
"description": "The identity of a patient, animal or group to list statements for",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Returns statements for a specific context (episode or episode of Care).",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search MedicationStatement operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/StructureDefinition": {
"post": {
"tags": [
"StructureDefinition"
],
"summary": "Create a StructureDefinition resource",
"operationId": "createStructureDefinition",
"responses": {
"201": {
"description": "Create StructureDefinition operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/StructureDefinition"
}
},
"get": {
"tags": [
"StructureDefinition"
],
"summary": "Search for StructureDefinition resources",
"operationId": "searchStructureDefinition",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "publisher",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derivation",
"description": "specialization | constraint - How relates to base definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "kind",
"description": "primitive-type | complex-type | resource | logical",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "base-path",
"description": "Path that identifies the base element",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "experimental",
"description": "For testing purposes, not real usage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jurisdiction",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "path",
"description": "A path that is constrained in the StructureDefinition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ext-context",
"description": "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "version",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "keyword",
"description": "A code for the StructureDefinition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abstract",
"description": "Whether the structure is abstract",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "valueset",
"description": "A vocabulary binding reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "base",
"description": "Definition that this type is constrained/specialized from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-value",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Type defined or constrained by this structure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search StructureDefinition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/StructureDefinition/_search": {
"post": {
"tags": [
"StructureDefinition"
],
"summary": "Search for StructureDefinition resources",
"operationId": "searchViaPostStructureDefinition",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "publisher",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derivation",
"description": "specialization | constraint - How relates to base definition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "kind",
"description": "primitive-type | complex-type | resource | logical",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "base-path",
"description": "Path that identifies the base element",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "experimental",
"description": "For testing purposes, not real usage",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jurisdiction",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "path",
"description": "A path that is constrained in the StructureDefinition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ext-context",
"description": "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "version",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "keyword",
"description": "A code for the StructureDefinition",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "abstract",
"description": "Whether the structure is abstract",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "valueset",
"description": "A vocabulary binding reference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "base",
"description": "Definition that this type is constrained/specialized from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-value",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "Type defined or constrained by this structure",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search StructureDefinition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/StructureDefinition/{id}/_history/{vid}": {
"get": {
"tags": [
"StructureDefinition"
],
"summary": "Read specific version of a StructureDefinition resource",
"operationId": "vreadStructureDefinition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read StructureDefinition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/StructureDefinition"
}
}
}
}
}
}
},
"/StructureDefinition/{id}": {
"get": {
"tags": [
"StructureDefinition"
],
"summary": "Read a StructureDefinition resource",
"operationId": "readStructureDefinition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read StructureDefinition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/StructureDefinition"
}
}
}
}
}
},
"put": {
"tags": [
"StructureDefinition"
],
"summary": "Update an existing StructureDefinition resource",
"operationId": "updateStructureDefinition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update StructureDefinition operation successful"
},
"201": {
"description": "Create StructureDefinition operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/StructureDefinition"
}
},
"delete": {
"tags": [
"StructureDefinition"
],
"summary": "Delete a StructureDefinition resource",
"operationId": "deleteStructureDefinition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete StructureDefinition operation successful"
}
}
}
},
"/StructureDefinition/{id}/_history": {
"get": {
"tags": [
"StructureDefinition"
],
"summary": "Return the history of a StructureDefinition resource",
"operationId": "historyStructureDefinition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History StructureDefinition operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/StructureDefinition/_history": {
"get": {
"tags": [
"StructureDefinition"
],
"summary": "Get the whole system history for StructureDefinition resources",
"operationId": "wholeSystemHistoryStructureDefinition",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ValueSet": {
"post": {
"tags": [
"ValueSet"
],
"summary": "Create a ValueSet resource",
"operationId": "createValueSet",
"responses": {
"201": {
"description": "Create ValueSet operation successful"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ValueSet"
}
},
"get": {
"tags": [
"ValueSet"
],
"summary": "Search for ValueSet resources",
"operationId": "searchValueSet",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "publisher",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jurisdiction",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "version",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "This special parameter searches for codes in the value set. See additional notes on the ValueSet resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-value",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"description": "Identifies the value set expansion (business identifier)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reference",
"description": "A code system included or excluded in the value set or an imported value set",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search ValueSet operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ValueSet/_search": {
"post": {
"tags": [
"ValueSet"
],
"summary": "Search for ValueSet resources",
"operationId": "searchViaPostValueSet",
"parameters": [
{
"$ref": "#/components/parameters/_lastUpdatedParam"
},
{
"$ref": "#/components/parameters/_securityParam"
},
{
"$ref": "#/components/parameters/_tagParam"
},
{
"$ref": "#/components/parameters/_idParam"
},
{
"$ref": "#/components/parameters/_sourceParam"
},
{
"$ref": "#/components/parameters/_profileParam"
},
{
"name": "date",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "publisher",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jurisdiction",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "version",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "code",
"description": "This special parameter searches for codes in the value set. See additional notes on the ValueSet resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-value",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-type-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context-quantity",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"description": "Identifies the value set expansion (business identifier)",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "url",
"description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "reference",
"description": "A code system included or excluded in the value set or an imported value set",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
}
}
}
}
},
"responses": {
"200": {
"description": "Search ValueSet operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ValueSet/{id}/_history/{vid}": {
"get": {
"tags": [
"ValueSet"
],
"summary": "Read specific version of a ValueSet resource",
"operationId": "vreadValueSet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
},
{
"name": "vid",
"in": "path",
"required": true,
"description": "version identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Versioned read ValueSet operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/ValueSet"
}
}
}
}
}
}
},
"/ValueSet/{id}": {
"get": {
"tags": [
"ValueSet"
],
"summary": "Read a ValueSet resource",
"operationId": "readValueSet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Read ValueSet operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/ValueSet"
}
}
}
}
}
},
"put": {
"tags": [
"ValueSet"
],
"summary": "Update an existing ValueSet resource",
"operationId": "updateValueSet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Update ValueSet operation successful"
},
"201": {
"description": "Create ValueSet operation successful (requires 'updateCreateEnabled' configuration option)"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ValueSet"
}
},
"delete": {
"tags": [
"ValueSet"
],
"summary": "Delete a ValueSet resource",
"operationId": "deleteValueSet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Delete ValueSet operation successful"
}
}
}
},
"/ValueSet/{id}/_history": {
"get": {
"tags": [
"ValueSet"
],
"summary": "Return the history of a ValueSet resource",
"operationId": "historyValueSet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "logical identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History ValueSet operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/ValueSet/_history": {
"get": {
"tags": [
"ValueSet"
],
"summary": "Get the whole system history for ValueSet resources",
"operationId": "wholeSystemHistoryValueSet",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/metadata": {
"get": {
"tags": [
"Other"
],
"summary": "Get the FHIR Capability statement for this endpoint",
"operationId": "metadata",
"responses": {
"200": {
"description": "metadata operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CapabilityStatement"
}
}
}
}
}
}
},
"/": {
"post": {
"tags": [
"Other"
],
"summary": "Perform a batch operation",
"operationId": "batch",
"responses": {
"200": {
"description": "batch operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
},
"requestBody": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
},
"required": true
}
}
},
"/_history": {
"get": {
"tags": [
"Other"
],
"summary": "Get the whole system history",
"operationId": "wholeSystemHistory",
"parameters": [
{
"$ref": "#/components/parameters/_sortParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_beforeParam"
},
{
"$ref": "#/components/parameters/_countParam"
},
{
"$ref": "#/components/parameters/_typeParam"
}
],
"responses": {
"200": {
"description": "whole system history operation successful",
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}
}
},
"/$export": {
"get": {
"tags": [
"Other"
],
"summary": "Export data from the FHIR server",
"operationId": "getExport",
"parameters": [
{
"$ref": "#/components/parameters/_outputFormatParam"
},
{
"$ref": "#/components/parameters/_sinceParam"
},
{
"$ref": "#/components/parameters/_typeParam"
}
],
"responses": {
"202": {
"description": "Export job is initiated",
"headers": {
"Content-Location": {
"description": "The polling location",
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"tags": [
"Other"
],
"summary": "Export data from the FHIR server",
"operationId": "postExport",
"requestBody": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Parameters"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Export job is initiated",
"headers": {
"Content-Location": {
"description": "The polling location",
"schema": {
"type": "string"
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"_lastUpdatedParam": {
"name": "_lastUpdated",
"description": "When the resource version last changed",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_securityParam": {
"name": "_security",
"description": "Security Labels applied to this resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_tagParam": {
"name": "_tag",
"description": "Tags applied to this resource",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_idParam": {
"name": "_id",
"description": "Logical id of this artifact",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_sourceParam": {
"name": "_source",
"description": "Identifies where the resource comes from",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_profileParam": {
"name": "_profile",
"description": "Profiles this resource claims to conform to",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_sortParam": {
"name": "_sort",
"description": "Sort the returned data using one of three options: \r\n\r\n* -_lastUpdated: [Default] Decreasing time - most recent changes first\r\n* _lastUpdated: Increasing time - oldest changes first\r\n* none: Increasing id order - oldest changes first\r\n",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"-_lastUpdated",
"_lastUpdated",
"none"
]
}
},
"_sinceParam": {
"name": "_since",
"description": "Resources updated after this period will be included in the response.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_beforeParam": {
"name": "_before",
"description": "Return changes before a known timestamp",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_countParam": {
"name": "_count",
"description": "Specifies a maximum number of results that are required",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 100
}
},
"_typeParam": {
"name": "_type",
"description": "Limit which resource types are returned",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
"_outputFormatParam": {
"name": "_outputFormat",
"description": "The format for the requested bulk data files to be generated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
},
"requestBodies": {
"AllergyIntolerance": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/AllergyIntolerance"
}
}
},
"required": true
},
"CarePlan": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CarePlan"
}
}
},
"required": true
},
"CareTeam": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CareTeam"
}
}
},
"required": true
},
"CodeSystem": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/CodeSystem"
}
}
},
"required": true
},
"Condition": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Condition"
}
}
},
"required": true
},
"Consent": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Consent"
}
}
},
"required": true
},
"Coverage": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Coverage"
}
}
},
"required": true
},
"Device": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Device"
}
}
},
"required": true
},
"Group": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"required": true
},
"Provenance": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Provenance"
}
}
},
"required": true
},
"DiagnosticReport": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/DiagnosticReport"
}
}
},
"required": true
},
"ExplanationOfBenefit": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/ExplanationOfBenefit"
}
}
},
"required": true
},
"List": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/List"
}
}
},
"required": true
},
"DocumentReference": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/DocumentReference"
}
}
},
"required": true
},
"Observation": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Observation"
}
}
},
"required": true
},
"MedicationAdministration": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationAdministration"
}
}
},
"required": true
},
"Encounter": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Encounter"
}
}
},
"required": true
},
"Procedure": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Procedure"
}
}
},
"required": true
},
"MedicationRequest": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationRequest"
}
}
},
"required": true
},
"Goal": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Goal"
}
}
},
"required": true
},
"Immunization": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Immunization"
}
}
},
"required": true
},
"Location": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
},
"required": true
},
"Medication": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Medication"
}
}
},
"required": true
},
"MedicationDispense": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationDispense"
}
}
},
"required": true
},
"MedicationStatement": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/MedicationStatement"
}
}
},
"required": true
},
"Organization": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
},
"required": true
},
"Patient": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Patient"
}
}
},
"required": true
},
"Practitioner": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/Practitioner"
}
}
},
"required": true
},
"PractitionerRole": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/PractitionerRole"
}
}
},
"required": true
},
"StructureDefinition": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/StructureDefinition"
}
}
},
"required": true
},
"ValueSet": {
"content": {
"application/fhir+json": {
"schema": {
"$ref": "#/components/schemas/ValueSet"
}
}
},
"required": true
}
},
"schemas": {
"Resource": {
"type": "object",
"discriminator": {
"propertyName": "resourceType"
},
"properties": {
"resourceType": {
"type": "string",
"enum": [
"Resource",
"DomainResource",
"Account",
"ActivityDefinition",
"AdverseEvent",
"AllergyIntolerance",
"Appointment",
"AppointmentResponse",
"AuditEvent",
"Basic",
"Binary",
"BiologicallyDerivedProduct",
"BodyStructure",
"Bundle",
"CapabilityStatement",
"CarePlan",
"CareTeam",
"CatalogEntry",
"ChargeItem",
"ChargeItemDefinition",
"Claim",
"ClaimResponse",
"ClinicalImpression",
"CodeSystem",
"Communication",
"CommunicationRequest",
"CompartmentDefinition",
"Composition",
"ConceptMap",
"Condition",
"Consent",
"Contract",
"Coverage",
"CoverageEligibilityRequest",
"CoverageEligibilityResponse",
"DetectedIssue",
"Device",
"DeviceDefinition",
"DeviceMetric",
"DeviceRequest",
"DeviceUseStatement",
"DiagnosticReport",
"DocumentManifest",
"DocumentReference",
"EffectEvidenceSynthesis",
"Encounter",
"Endpoint",
"EnrollmentRequest",
"EnrollmentResponse",
"EpisodeOfCare",
"EventDefinition",
"Evidence",
"EvidenceVariable",
"ExampleScenario",
"ExplanationOfBenefit",
"FamilyMemberHistory",
"Flag",
"Goal",
"GraphDefinition",
"Group",
"GuidanceResponse",
"HealthcareService",
"ImagingStudy",
"Immunization",
"ImmunizationEvaluation",
"ImmunizationRecommendation",
"ImplementationGuide",
"InsurancePlan",
"Invoice",
"Library",
"Linkage",
"List",
"Location",
"Measure",
"MeasureReport",
"Media",
"Medication",
"MedicationAdministration",
"MedicationDispense",
"MedicationKnowledge",
"MedicationRequest",
"MedicationStatement",
"MedicinalProduct",
"MedicinalProductAuthorization",
"MedicinalProductContraindication",
"MedicinalProductIndication",
"MedicinalProductIngredient",
"MedicinalProductInteraction",
"MedicinalProductManufactured",
"MedicinalProductPackaged",
"MedicinalProductPharmaceutical",
"MedicinalProductUndesirableEffect",
"MessageDefinition",
"MessageHeader",
"MolecularSequence",
"NamingSystem",
"NutritionOrder",
"Observation",
"ObservationDefinition",
"OperationDefinition",
"OperationOutcome",
"Organization",
"OrganizationAffiliation",
"Parameters",
"Patient",
"PaymentNotice",
"PaymentReconciliation",
"Person",
"PlanDefinition",
"Practitioner",
"PractitionerRole",
"Procedure",
"Provenance",
"Questionnaire",
"QuestionnaireResponse",
"RelatedPerson",
"RequestGroup",
"ResearchDefinition",
"ResearchElementDefinition",
"ResearchStudy",
"ResearchSubject",
"RiskAssessment",
"RiskEvidenceSynthesis",
"Schedule",
"SearchParameter",
"ServiceRequest",
"Slot",
"Specimen",
"SpecimenDefinition",
"StructureDefinition",
"StructureMap",
"Subscription",
"Substance",
"SubstanceNucleicAcid",
"SubstancePolymer",
"SubstanceProtein",
"SubstanceReferenceInformation",
"SubstanceSourceMaterial",
"SubstanceSpecification",
"SupplyDelivery",
"SupplyRequest",
"Task",
"TerminologyCapabilities",
"TestReport",
"TestScript",
"ValueSet",
"VerificationResult",
"VisionPrescription"
]
},
"id": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."
},
"meta": {
"$ref": "#/components/schemas/Meta",
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."
},
"implicitRules": {
"type": "string",
"pattern": "\\S*",
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."
},
"language": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The base language in which the resource is written."
}
},
"required": [
"resourceType"
]
},
"DomainResource": {
"allOf": [
{
"$ref": "#/components/schemas/Resource"
},
{
"type": "object",
"properties": {
"text": {
"$ref": "#/components/schemas/Narrative",
"description": "A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."
},
"contained": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource",
"description": "These resources do not have an independent existence apart from the resource that contains them – they cannot be identified independently, and nor can they have their own independent transaction scope."
}
},
"extension": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Extension",
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."
}
},
"modifierExtension": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Extension",
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
}
}
}
}
]
},
"Bundle": {
"allOf": [
{
"$ref": "#/components/schemas/Resource"
},
{
"type": "object",
"properties": {
"identifier": {
"$ref": "#/components/schemas/Identifier",
"description": "A persistent identifier for the bundle that won't change as a bundle is copied from server to server."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates the purpose of this bundle – how it is intended to be used."
},
"timestamp": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle."
},
"total": {
"type": "integer",
"format": "int32",
"description": "If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle."
},
"link": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundle_Link",
"description": "A series of links that provide context to this bundle."
}
},
"entry": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundle_Entry",
"description": "An entry in a bundle resource – will either contain a resource or information about a resource (transactions and history only)."
}
},
"signature": {
"$ref": "#/components/schemas/Signature",
"description": "Digital Signature – base64 encoded. XML–DSig or a JWT."
}
},
"required": [
"type"
]
}
],
"example": {
"resourceType": "Bundle",
"meta": {
"versionId": "VD9dxMjhBQ",
"lastUpdated": "2021-04-12T14:34:37.652-05:00",
"source": "JUp4RZhVMR",
"profile": [
"Fec0pB4qv3"
],
"security": [
{
"system": "dO8eKozGdg",
"version": "g2Z1yrpGqL",
"code": "AaVP6dRWHJ",
"display": "MOdc7BqdCe",
"userSelected": true
}
],
"tag": [
{
"system": "9XfImFywbS",
"version": "cpOXk_fnfK",
"code": "VwBBYWM5YE",
"display": "GGrdyf7kSX",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "f9UW4JtFH9",
"language": "en-US",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "25m4g6AC04",
"version": "EmPuWoNHGO",
"code": "FuuaG1RtIb",
"display": "z4dys_Vt0Y",
"userSelected": true
}
],
"text": "OX8cTeTDLr"
},
"system": "a5bA7vXyCl",
"value": "RUJ35DJz4T",
"period": {
"start": "2021-04-12T14:34:37.641-05:00",
"end": "2021-04-12T14:34:37.641-05:00"
}
},
"type": "transaction-response",
"timestamp": "2021-04-12T14:34:37.645-05:00",
"total": 1574108328,
"link": [
{
"relation": "9gsxK0gdZd",
"url": "x5puA71jvk"
}
],
"entry": [
{
"link": [
{
"relation": "wJ0wLub8sj",
"url": "HFm_mzHn2z"
}
],
"fullUrl": "sYNHpCvLu6",
"search": {
"mode": "outcome",
"score": 8960673372
},
"request": {
"method": "PATCH",
"url": "8jiWbkD8S7",
"ifNoneMatch": "AdZT_le7SH",
"ifModifiedSince": "2021-04-12T14:34:37.647-05:00",
"ifMatch": "PQD4pHngAm",
"ifNoneExist": "saa1HX7us2"
},
"response": {
"status": "lT5ZNvdH4r",
"location": "o7f0kua08h",
"etag": "4kMlqpFwlq",
"lastModified": "2021-04-12T14:34:37.646-05:00"
}
}
],
"signature": {
"type": [
{
"system": "SCaxhhhYHf",
"version": "bIsWXgnGWT",
"code": "uIuNEKeok2",
"display": "09v4Og5VO1",
"userSelected": true
}
],
"when": "2021-04-12T14:34:37.644-05:00",
"who": {
"reference": "Practitioner/3BxOedQTGQ",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "EBWsJFiSee",
"version": "tM3MDDp49w",
"code": "YBhQUC48Io",
"display": "WUQKZlqzSt",
"userSelected": true
}
],
"text": "ChRS8TCGUi"
},
"system": "D4ZGHPnrPM",
"value": "DQ1bc4APiL",
"period": {
"start": "2021-04-12T14:34:37.643-05:00",
"end": "2021-04-12T14:34:37.643-05:00"
}
},
"display": "Rw9DdhNaHA"
},
"onBehalfOf": {
"reference": "Practitioner/PDaucuqEoc",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "CZTG15XRKE",
"version": "l29nYs4v3D",
"code": "hRcCFBqxMk",
"display": "pWv3KBIMIs",
"userSelected": true
}
],
"text": "epk3OT1lD8"
},
"system": "gHBW2H7m4P",
"value": "LD4_EQrH3N",
"period": {
"start": "2021-04-12T14:34:37.642-05:00",
"end": "2021-04-12T14:34:37.642-05:00"
}
},
"display": "HOdn3UAvlg"
},
"targetFormat": "NCDfzz08UJ",
"sigFormat": "OR9Y23khox",
"data": "aHg6D2k="
}
}
},
"Bundle_Link": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"relation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1)."
},
"url": {
"type": "string",
"pattern": "\\S*",
"description": "The reference details for the link."
}
},
"required": [
"relation",
"url"
]
}
]
},
"Bundle_Entry": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"link": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundle_Link",
"description": "A series of links that provide context to this entry."
}
},
"fullUrl": {
"type": "string",
"pattern": "\\S*",
"description": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified."
},
"resource": {
"$ref": "#/components/schemas/Resource",
"description": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type."
},
"search": {
"$ref": "#/components/schemas/Bundle_Entry_Search",
"description": "Information about the search process that lead to the creation of this entry."
},
"request": {
"$ref": "#/components/schemas/Bundle_Entry_Request",
"description": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry."
},
"response": {
"$ref": "#/components/schemas/Bundle_Entry_Response",
"description": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history."
}
}
}
]
},
"Bundle_Entry_Request": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"method": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred."
},
"url": {
"type": "string",
"pattern": "\\S*",
"description": "The URL for this entry, relative to the root (the address to which the request is posted)."
},
"ifNoneMatch": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread)."
},
"ifModifiedSince": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread)."
},
"ifMatch": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency)."
},
"ifNoneExist": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL – what follows the \"?\" (not including the \"?\")."
}
},
"required": [
"method",
"url"
]
}
]
},
"Bundle_Entry_Response": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code."
},
"location": {
"type": "string",
"pattern": "\\S*",
"description": "The location header created by processing this operation, populated if the operation returns a location."
},
"etag": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency))."
},
"lastModified": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The date/time that the resource was modified on the server."
},
"outcome": {
"$ref": "#/components/schemas/Resource",
"description": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction."
}
},
"required": [
"status"
]
}
]
},
"Bundle_Entry_Search": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process."
},
"score": {
"type": "number",
"description": "When searching, the server's search ranking score for the entry."
}
}
}
]
},
"CapabilityStatement": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers."
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation."
},
"title": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A short, descriptive, user–friendly title for the capability statement."
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of this capability statement. Enables tracking the life–cycle of the content."
},
"experimental": {
"type": "boolean",
"description": "A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes."
},
"publisher": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the organization or individual that published the capability statement."
},
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactDetail",
"description": "Contact details to assist a user in finding and communicating with the publisher."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP."
},
"useContext": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageContext",
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances."
}
},
"jurisdiction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A legal or geographic region in which the capability statement is intended to be used."
}
},
"purpose": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Explanation of why this capability statement is needed and why it has been designed as it has."
},
"copyright": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement."
},
"kind": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase)."
},
"instantiates": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details."
}
},
"imports": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them."
}
},
"software": {
"$ref": "#/components/schemas/CapabilityStatement_Software",
"description": "Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation."
},
"implementation": {
"$ref": "#/components/schemas/CapabilityStatement_Implementation",
"description": "Identifies a specific implementation instance that is described by the capability statement – i.e. a particular installation, rather than the capabilities of a software program."
},
"fhirVersion": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value."
},
"format": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A list of the formats supported by this implementation using their content types."
},
"minItems": 1
},
"patchFormat": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A list of the patch formats supported by this implementation using their content types."
}
},
"implementationGuide": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "A list of implementation guides that the server does (or should) support in their entirety."
}
},
"rest": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest",
"description": "A definition of the restful capabilities of the solution, if any."
}
},
"messaging": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Messaging",
"description": "A description of the messaging capabilities of the solution."
}
},
"document": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Document",
"description": "A document definition."
}
}
},
"required": [
"status",
"date",
"kind",
"fhirVersion",
"format"
]
}
],
"example": {
"resourceType": "CapabilityStatement",
"meta": {
"versionId": "XmngMKE3MJ",
"lastUpdated": "2021-04-12T14:34:35.908-05:00",
"source": "8qDPXP0PfE",
"profile": [
"rNK1WjuQYh"
],
"security": [
{
"system": "bWEcsGqjTd",
"version": "pMm1j6hfKx",
"code": "lojvTQjFoc",
"display": "KtU6HCJkSi",
"userSelected": true
}
],
"tag": [
{
"system": "ogCtziWVK1",
"version": "enZVX25nNx",
"code": "aZmKmMcm0k",
"display": "eZJLzp9oEh",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "rX06MDa9ab",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"url": "FVe3UpI7aJ",
"version": "ogjL_11T09",
"name": "yNgdvBJVEh",
"title": "8yafW_sJJa",
"status": "retired",
"experimental": true,
"date": "2021-04-12T14:34:35.908-05:00",
"publisher": "BsNSs78U1B",
"contact": [
{
"name": "yB1BDwQb1j",
"telecom": [
{
"system": "phone",
"value": "FV_xIJNj52",
"use": "work",
"rank": 501270782,
"period": {
"start": "2021-04-12T14:34:35.906-05:00",
"end": "2021-04-12T14:34:35.906-05:00"
}
}
]
}
],
"description": "WVriF4diMt",
"useContext": [
{
"code": {
"system": "wcrufzoVzm",
"version": "Kj2wxlfuu6",
"code": "dOsxTUwLB4",
"display": "vR7xoexPa_",
"userSelected": true
},
"valueCodeableConcept": {
"coding": [
{
"system": "MPsGIZR9yC",
"version": "wiZh58MnKL",
"code": "ORkhTk717T",
"display": "2fN6PeZ0bu",
"userSelected": true
}
],
"text": "pwuPhNGQou"
}
}
],
"jurisdiction": [
{
"coding": [
{
"system": "zp0n8L8ul0",
"version": "x_FbMy97Xm",
"code": "KqTpFX0eJU",
"display": "_zf3xUv7dX",
"userSelected": true
}
],
"text": "hJaHTuhRjx"
}
],
"purpose": "hMR2WC69GM",
"copyright": "YIjLRu6tmJ",
"kind": "instance",
"instantiates": [
"ov8KTsW2Fk"
],
"imports": [
"bJVAMyjQQ3"
],
"software": {
"name": "UT5hk6FoZ3",
"version": "jOnjsYO_wH",
"releaseDate": "2021-04-12T14:34:35.886-05:00"
},
"implementation": {
"description": "hf4IcWEK5Z",
"url": "ONCct88W9C",
"custodian": {
"reference": "Organization/8eGiCubuPO",
"type": "Organization",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "L6yT7vE7ml",
"version": "BdCNwKOo8K",
"code": "z2TYI4SNnh",
"display": "3d87Z0uEr9",
"userSelected": true
}
],
"text": "C6rcBWS1rc"
},
"system": "exU0eaRl4X",
"value": "FV2fULujwX",
"period": {
"start": "2021-04-12T14:34:35.905-05:00",
"end": "2021-04-12T14:34:35.905-05:00"
}
},
"display": "llbgC7pJ9I"
}
},
"fhirVersion": "0.5.0",
"format": [
"lN3pBHzF9t"
],
"patchFormat": [
"b05jbsg6s0"
],
"implementationGuide": [
"rwl6_e6hLw"
],
"rest": [
{
"mode": "client",
"documentation": "mS7cfc18c_",
"security": {
"cors": true,
"service": [
{
"coding": [
{
"system": "HYG4E5eSd9",
"version": "Nev7XxktIL",
"code": "GwwE4f4ZLs",
"display": "rDyoWSSRDN",
"userSelected": true
}
],
"text": "z70xND1fBu"
}
],
"description": "xvjM5DBlvC"
},
"resource": [
{
"type": "TestReport",
"profile": "SADmydIFWx",
"supportedProfile": [
"R5OrMGFMKx"
],
"documentation": "gKJIVb6VlY",
"interaction": [
{
"code": "vread",
"documentation": "9FEUGN8hO8"
}
],
"versioning": "versioned",
"readHistory": true,
"updateCreate": true,
"conditionalCreate": true,
"conditionalRead": "full-support",
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"logical"
],
"searchInclude": [
"T09la8op31"
],
"searchRevInclude": [
"RUcNJR6C8O"
],
"searchParam": [
{
"name": "I9vvguUKM4",
"definition": "zBc5s1mobY",
"type": "special",
"documentation": "xoR9PGmwFk"
}
],
"operation": [
{
"name": "1M0QGV5koj",
"definition": "RxMQSWfV85",
"documentation": "vWeTxp1kLm"
}
]
}
],
"interaction": [
{
"code": "history-system",
"documentation": "Roh_LYTA6z"
}
],
"searchParam": [
{
"name": "T3V599e5NN",
"definition": "snQ3cMDPg5",
"type": "reference",
"documentation": "lTpahM93fI"
}
],
"operation": [
{
"name": "goIubeCcyv",
"definition": "exUSX2SF2P",
"documentation": "OCXe0b1bFd"
}
],
"compartment": [
"PR3odK7mBX"
]
}
],
"messaging": [
{
"endpoint": [
{
"protocol": {
"system": "MimKOlymZA",
"version": "Ay_G30_hai",
"code": "wBWMBGLttN",
"display": "D20b2nLBWt",
"userSelected": true
},
"address": "SkIakWwI_G"
}
],
"reliableCache": 1049748079,
"documentation": "OiIN23ZUyM",
"supportedMessage": [
{
"mode": "receiver",
"definition": "Vz7yddlLpg"
}
]
}
],
"document": [
{
"mode": "producer",
"documentation": "eAYrSNoOJe",
"profile": "2Nk0uNR_c1"
}
]
}
},
"CapabilityStatement_Software": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Name the software is known by."
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The version identifier for the software covered by this statement."
},
"releaseDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Date this version of the software was released."
}
},
"required": [
"name"
]
}
]
},
"CapabilityStatement_Implementation": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Information about the specific installation that this capability statement relates to."
},
"url": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces."
},
"custodian": {
"$ref": "#/components/schemas/Reference",
"description": "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL."
}
},
"required": [
"description"
]
}
]
},
"CapabilityStatement_Rest": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Information about the system's restful capabilities that apply across all applications, such as security."
},
"security": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Security",
"description": "Information about security implementation from an interface perspective – what a client needs to know."
},
"resource": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Resource",
"description": "A specification of the restful capabilities of the solution for a specific resource type."
}
},
"interaction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Interaction",
"description": "A specification of restful operations supported by the system."
}
},
"searchParam": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Resource_SearchParam",
"description": "Search parameters that are supported for searching all resources for implementations to support and/or make use of – either references to ones defined in the specification, or additional ones defined for/by the implementation."
}
},
"operation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Resource_Operation",
"description": "Definition of an operation or a named query together with its parameters and their meaning and type."
}
},
"compartment": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL ."
}
}
},
"required": [
"mode"
]
}
]
},
"CapabilityStatement_Rest_Security": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"cors": {
"type": "boolean",
"description": "Server adds CORS headers when responding to requests – this enables Javascript applications to use the server."
},
"service": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Types of security services that are supported/required by the system."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "General description of how security works."
}
}
}
]
},
"CapabilityStatement_Rest_Resource": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A type of resource exposed via the restful interface."
},
"profile": {
"type": "string",
"pattern": "\\S*",
"description": "A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile–uses)."
},
"supportedProfile": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "A list of profiles that represent different use cases supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile–uses)."
}
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Additional information about the resource type used by the system."
},
"interaction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Resource_Interaction",
"description": "Identifies a restful operation supported by the solution."
}
},
"versioning": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "This field is set to no–version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta–property on resources. If the value is 'versioned–update', then the server supports all the versioning features, including using e–tags for version integrity in the API."
},
"readHistory": {
"type": "boolean",
"description": "A flag for whether the server is able to return past versions as part of the vRead operation."
},
"updateCreate": {
"type": "boolean",
"description": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server."
},
"conditionalCreate": {
"type": "boolean",
"description": "A flag that indicates that the server supports conditional create."
},
"conditionalRead": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code that indicates how the server supports conditional read."
},
"conditionalUpdate": {
"type": "boolean",
"description": "A flag that indicates that the server supports conditional update."
},
"conditionalDelete": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code that indicates how the server supports conditional delete."
},
"referencePolicy": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A set of flags that defines how references are supported."
}
},
"searchInclude": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A list of _include values supported by the server."
}
},
"searchRevInclude": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A list of _revinclude (reverse include) values supported by the server."
}
},
"searchParam": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Resource_SearchParam",
"description": "Search parameters for implementations to support and/or make use of – either references to ones defined in the specification, or additional ones defined for/by the implementation."
}
},
"operation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Rest_Resource_Operation",
"description": "Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters."
}
}
},
"required": [
"type"
]
}
]
},
"CapabilityStatement_Rest_Resource_Interaction": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Coded identifier of the operation, supported by the system resource."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre–authorized certificates only'."
}
},
"required": [
"code"
]
}
]
},
"CapabilityStatement_Rest_Resource_SearchParam": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the search parameter used in the interface."
},
"definition": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter–definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The type of value a search parameter refers to, and how the content is interpreted."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms."
}
},
"required": [
"name",
"type"
]
}
]
},
"CapabilityStatement_Rest_Resource_Operation": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called."
},
"definition": {
"type": "string",
"pattern": "\\S*",
"description": "Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet–expand```), that means it supports the full capabilities of the operation – e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance–level invocation of the operation."
}
},
"required": [
"name",
"definition"
]
}
]
},
"CapabilityStatement_Rest_Interaction": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Coded identifier of the operation, supported by the system resource."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre–authorized certificates only'."
}
},
"required": [
"code"
]
}
]
},
"CapabilityStatement_Messaging": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"endpoint": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Messaging_Endpoint",
"description": "An endpoint (network accessible address) to which messages and/or replies are to be sent."
}
},
"reliableCache": {
"type": "integer",
"format": "int32",
"description": "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender)."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner."
},
"supportedMessage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityStatement_Messaging_SupportedMessage",
"description": "References to message definitions for messages this system can send or receive."
}
}
}
}
]
},
"CapabilityStatement_Messaging_Endpoint": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"protocol": {
"$ref": "#/components/schemas/Coding",
"description": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint."
},
"address": {
"type": "string",
"pattern": "\\S*",
"description": "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier."
}
},
"required": [
"protocol",
"address"
]
}
]
},
"CapabilityStatement_Messaging_SupportedMessage": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The mode of this event declaration – whether application is sender or receiver."
},
"definition": {
"type": "string",
"pattern": "\\S*",
"description": "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc."
}
},
"required": [
"mode",
"definition"
]
}
]
},
"CapabilityStatement_Document": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Mode of this document declaration – whether an application is a producer or consumer."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc."
},
"profile": {
"type": "string",
"pattern": "\\S*",
"description": "A profile on the document Bundle that constrains which resources are present, and their contents."
}
},
"required": [
"mode",
"profile"
]
}
]
},
"OperationOutcome": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"issue": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationOutcome_Issue",
"description": "An error, warning, or information message that results from a system action."
},
"minItems": 1
}
},
"required": [
"issue"
]
}
],
"example": {
"resourceType": "OperationOutcome",
"meta": {
"versionId": "BnpJOa5-Sb",
"lastUpdated": "2021-04-12T14:34:36.061-05:00",
"source": "BCL3d5NERb",
"profile": [
"xSempdez3Y"
],
"security": [
{
"system": "tczS7uP8XL",
"version": "IXKbCw05qO",
"code": "NvDP1hL64Y",
"display": "_r1z5oJld1",
"userSelected": true
}
],
"tag": [
{
"system": "2qqXHsE1Mx",
"version": "lybFyQ1tBj",
"code": "Q9w075fYd3",
"display": "Nm2QqbYibP",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "l8KHk6qOt4",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"issue": [
{
"severity": "warning",
"code": "business-rule",
"details": {
"coding": [
{
"system": "eQgFofRHmJ",
"version": "T524HDk5Za",
"code": "tC_7iQg31j",
"display": "s0bLc4W5KE",
"userSelected": true
}
],
"text": "BfBVppHmsh"
},
"diagnostics": "EcvPDGbK0q",
"location": [
"GK5ihTmfe6"
],
"expression": [
"Uidx_swV4Z"
]
}
]
}
},
"OperationOutcome_Issue": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"severity": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates whether the issue indicates a variation from successful processing."
},
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element."
},
"details": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Additional details about the error. This may be a text description of the error or a system code that identifies the error."
},
"diagnostics": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Additional diagnostic information about the issue."
},
"location": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name."
}
},
"expression": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised."
}
}
},
"required": [
"severity",
"code"
]
}
]
},
"Parameters": {
"allOf": [
{
"$ref": "#/components/schemas/Resource"
},
{
"type": "object",
"properties": {
"parameter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Parameters_Parameter",
"description": "A parameter passed to or received from the operation."
}
}
}
}
],
"example": {
"resourceType": "Parameters",
"meta": {
"versionId": "lfjqVo3QsG",
"lastUpdated": "2021-04-12T14:34:36.699-05:00",
"source": "s743zG7XBN",
"profile": [
"Tpxg4YPYoT"
],
"security": [
{
"system": "tINJaM0Wd_",
"version": "GJuhC7M8qk",
"code": "e9cxa6RD4Y",
"display": "XN8r7mEQFC",
"userSelected": true
}
],
"tag": [
{
"system": "0_pqaPkTYg",
"version": "r9wCEUftM4",
"code": "XIt_kh2kej",
"display": "b8y2HtrKag",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "zaxn2Gp74x",
"language": "en-US",
"parameter": [
{
"name": "YDPoj9m3N6",
"valueBase64Binary": "RGEQPyI="
}
]
}
},
"AllergyIntolerance": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server."
}
},
"clinicalStatus": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The clinical status of the allergy or intolerance."
},
"verificationStatus": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identification of the underlying physiological mechanism for the reaction risk."
},
"category": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Category of the identified substance."
}
},
"criticality": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance."
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\") or a general or categorical negated statement (e.g., \"No known allergy\", \"No known drug allergies\"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance."
},
"patient": {
"$ref": "#/components/schemas/Reference",
"description": "The patient who has the allergy or intolerance."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The encounter when the allergy or intolerance was asserted."
},
"onsetDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Estimated or actual date, date–time, or age when allergy or intolerance was identified."
},
"onsetAge": {
"$ref": "#/components/schemas/Age",
"description": "Estimated or actual date, date–time, or age when allergy or intolerance was identified."
},
"onsetPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Estimated or actual date, date–time, or age when allergy or intolerance was identified."
},
"onsetRange": {
"$ref": "#/components/schemas/Range",
"description": "Estimated or actual date, date–time, or age when allergy or intolerance was identified."
},
"onsetString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Estimated or actual date, date–time, or age when allergy or intolerance was identified."
},
"recordedDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system–generated date."
},
"recorder": {
"$ref": "#/components/schemas/Reference",
"description": "Individual who recorded the record and takes responsibility for its content."
},
"asserter": {
"$ref": "#/components/schemas/Reference",
"description": "The source of the information about the allergy that is recorded."
},
"lastOccurrence": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Represents the date and/or time of the last known occurrence of a reaction event."
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields."
}
},
"reaction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllergyIntolerance_Reaction",
"description": "Details about each adverse reaction event linked to exposure to the identified substance."
}
}
},
"required": [
"patient"
]
}
],
"example": {
"resourceType": "AllergyIntolerance",
"meta": {
"versionId": "FoMdlA-2Gm",
"lastUpdated": "2021-04-12T14:34:28.805-05:00",
"source": "A0SozKlzGC",
"profile": [
"cPKE7v0y3b"
],
"security": [
{
"system": "wNKQ9ou0jX",
"version": "ELVtHj8Flu",
"code": "QRUzWBBcKP",
"display": "w7FKs_TO0q",
"userSelected": true
}
],
"tag": [
{
"system": "QDk9ksVG3s",
"version": "00Vd4JGNmB",
"code": "nWvBIXjJO9",
"display": "X0oix3pGu8",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "PqcepZFmhX",
"language": "en-US",
"text": {
"status": "empty",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "temp",
"type": {
"coding": [
{
"system": "DabLUEtgqi",
"version": "rwLV0yzWEj",
"code": "5loHHpS0_C",
"display": "SJblMI97sv",
"userSelected": true
}
],
"text": "rGdyrWMYMm"
},
"system": "T2ywsWVuCN",
"value": "CfG86ANz9L",
"period": {
"start": "2021-04-12T14:34:28.79-05:00",
"end": "2021-04-12T14:34:28.791-05:00"
}
}
],
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"version": "4.0.1",
"code": "active",
"display": "Active",
"userSelected": false
}
],
"text": "active"
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"version": "4.0.1",
"code": "unconfirmed",
"display": "Unconfirmed",
"userSelected": false
}
],
"text": "unconfirmed"
},
"type": "allergy",
"category": [
"medication"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "B550aT_bBE",
"version": "AYO4z7uCgO",
"code": "kUVJfWWkCl",
"display": "CRXI93vANJ",
"userSelected": true
}
],
"text": "qrJ7tGIPYV"
},
"patient": {
"reference": "Patient/uvAb3p0pFF",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "TzH_JZ04E7",
"version": "fn5Yz6Mk4c",
"code": "fvfjx8Ba3U",
"display": "6PjT2erM8x",
"userSelected": true
}
],
"text": "JQMjrB2sdM"
},
"system": "UW6HjoEyUK",
"value": "SBcOp8aqg2",
"period": {
"start": "2021-04-12T14:34:28.788-05:00",
"end": "2021-04-12T14:34:28.789-05:00"
}
},
"display": "clnG9AQdbN"
},
"encounter": {
"reference": "Encounter/mNqhSBSRB6",
"type": "Encounter",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "0OYWnTjvc1",
"version": "LeS2XCKY_E",
"code": "VINq7huFf1",
"display": "nnLF2fbO3o",
"userSelected": true
}
],
"text": "Z8Lmadx_1C"
},
"system": "N9AcFdVNts",
"value": "TD8uFWukA9",
"period": {
"start": "2021-04-12T14:34:28.802-05:00",
"end": "2021-04-12T14:34:28.802-05:00"
}
},
"display": "tUlC1YSbUn"
},
"onsetDateTime": "2021-04-12T14:34:28.8-05:00",
"recordedDate": "2021-04-12T14:34:28.788-05:00",
"recorder": {
"reference": "Practitioner/3dI9xoEOpM",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "z1lxeqTFow",
"version": "09hgCr5Cuc",
"code": "1OzzWDqUQk",
"display": "A9R5e589F7",
"userSelected": true
}
],
"text": "XhXymeS78D"
},
"system": "WbCQZaPgQl",
"value": "3CAW5FdRvx",
"period": {
"start": "2021-04-12T14:34:28.787-05:00",
"end": "2021-04-12T14:34:28.787-05:00"
}
},
"display": "tauzbSFE4b"
},
"asserter": {
"reference": "Patient/nwVjqyPs48",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "zcSUUWvI8G",
"version": "TdFUTauMPq",
"code": "XzT7HYH8xA",
"display": "FnQg8mwpkj",
"userSelected": true
}
],
"text": "SvlThabVTO"
},
"system": "DG5Pi8jirD",
"value": "6L8aCN6G0T",
"period": {
"start": "2021-04-12T14:34:28.794-05:00",
"end": "2021-04-12T14:34:28.794-05:00"
}
},
"display": "8xDGEfkneu"
},
"lastOccurrence": "2021-04-12T14:34:28.801-05:00",
"note": [
{
"authorReference": {
"reference": "Practitioner/4v3C5KH2Se",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "noVVFmskKB",
"version": "1CFxoKln3T",
"code": "TCHwtVH5JX",
"display": "DOOsqJIxMi",
"userSelected": true
}
],
"text": "g_L5QBvTNm"
},
"system": "GCwKJGlu2L",
"value": "suSytJ57FM",
"period": {
"start": "2021-04-12T14:34:28.793-05:00",
"end": "2021-04-12T14:34:28.793-05:00"
}
},
"display": "CqFe8Kyeeh"
},
"time": "2021-04-12T14:34:28.794-05:00",
"text": "5PhNlq1xyD"
}
],
"reaction": [
{
"substance": {
"coding": [
{
"system": "enMeNaN4P4",
"version": "O_U6MeHAxD",
"code": "P8t7DsKCm5",
"display": "MuHFdAq8Kp",
"userSelected": true
}
],
"text": "6L2ZzhKRNO"
},
"manifestation": [
{
"coding": [
{
"system": "6YrpJBSOAA",
"version": "oA4VzSBOAa",
"code": "8dWXsREwdW",
"display": "SE6SYmx0ll",
"userSelected": true
}
],
"text": "c66SAv60ch"
}
],
"description": "Xe4n48m55J",
"onset": "2021-04-12T14:34:28.798-05:00",
"severity": "severe",
"exposureRoute": {
"coding": [
{
"system": "g8wTEKUiFh",
"version": "ZFe9KsPKfy",
"code": "HTq40hALLQ",
"display": "YtMhjRZUiT",
"userSelected": true
}
],
"text": "SvQ9BlEJbH"
},
"note": [
{
"authorReference": {
"reference": "Practitioner/FvUOPAxRyb",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "SGudiz_jro",
"version": "NVgE1rR5MX",
"code": "mydFS1QrVt",
"display": "IL_UclodkE",
"userSelected": true
}
],
"text": "DvkNzpbwQI"
},
"system": "ATkO74Uw7L",
"value": "JuhNNDyXAc",
"period": {
"start": "2021-04-12T14:34:28.797-05:00",
"end": "2021-04-12T14:34:28.797-05:00"
}
},
"display": "iewsi63VR0"
},
"time": "2021-04-12T14:34:28.798-05:00",
"text": "Yzh0Hk8jjo"
}
]
}
]
}
},
"AllergyIntolerance_Reaction": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"substance": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance."
},
"manifestation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event."
},
"minItems": 1
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Text description about the reaction as a whole, including details of the manifestation if required."
},
"onset": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Record of the date and/or time of the onset of the Reaction."
},
"severity": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations."
},
"exposureRoute": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identification of the route by which the subject was exposed to the substance."
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Additional text about the adverse reaction event not captured in other fields."
}
}
},
"required": [
"manifestation"
]
}
]
},
"Element": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
},
"extension": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Extension",
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."
},
"example": [
{
"url": "http://example.com",
"valueString": "text value"
}
]
}
}
},
"BackboneElement": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"modifierExtension": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Extension",
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
}
}
}
}
]
},
"Address": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"use": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The purpose of this address."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care–of addresses). Most addresses are both."
},
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts."
},
"line": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information."
}
},
"city": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the city, town, suburb, village or other community or delivery center."
},
"district": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the administrative area (county)."
},
"state": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Sub–unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes)."
},
"postalCode": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A postal code designating a region defined by the postal service."
},
"country": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Country – a nation as commonly understood or generally accepted."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Time period when address was/is in use."
}
}
}
]
},
"Age": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
},
{
"type": "object",
"properties": {
}
}
]
},
"Annotation": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"authorReference": {
"$ref": "#/components/schemas/Reference",
"description": "The individual responsible for making the annotation."
},
"authorString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The individual responsible for making the annotation."
},
"time": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Indicates when this particular annotation was made."
},
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The text of the annotation in markdown format."
}
},
"required": [
"text"
]
}
]
},
"Attachment": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"contentType": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate."
},
"language": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The human language of the content. The value can be any valid value according to BCP 47."
},
"data": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "The actual data of the attachment – a sequence of bytes, base64 encoded."
},
"url": {
"type": "string",
"pattern": "\\S*",
"description": "A location where the data can be accessed."
},
"size": {
"type": "integer",
"format": "int32",
"description": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done)."
},
"hash": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "The calculated hash of the data using SHA–1. Represented using base64."
},
"title": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A label or set of text to display in place of the data."
},
"creation": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date that the attachment was first created."
}
}
}
]
},
"CodeableConcept": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"coding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "A reference to a code defined by a terminology system."
}
},
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user."
}
}
}
]
},
"Coding": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"system": {
"type": "string",
"pattern": "\\S*",
"description": "The identification of the code system that defines the meaning of the symbol in the code."
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged."
},
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination)."
},
"display": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A representation of the meaning of the code in the system, following the rules of the system."
},
"userSelected": {
"type": "boolean",
"description": "Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays)."
}
}
}
]
},
"ContactPoint": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"system": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Telecommunications form for contact point – what communications system is required to make use of the contact."
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)."
},
"use": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies the purpose for the contact point."
},
"rank": {
"type": "integer",
"format": "int32",
"description": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Time period when the contact point was/is in use."
}
}
}
]
},
"Count": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
},
{
"type": "object",
"properties": {
}
}
]
},
"Distance": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
},
{
"type": "object",
"properties": {
}
}
]
},
"Duration": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
},
{
"type": "object",
"properties": {
}
}
]
},
"HumanName": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"use": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies the purpose for this name."
},
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts."
},
"family": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father."
},
"given": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Given name."
}
},
"prefix": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name."
}
},
"suffix": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name."
}
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Indicates the period of time when this name was valid for the named person."
}
}
}
]
},
"Identifier": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"use": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The purpose of this identifier."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose."
},
"system": {
"type": "string",
"pattern": "\\S*",
"description": "Establishes the namespace for the value – that is, a URL that describes a set values that are unique."
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The portion of the identifier typically relevant to the user and which is unique within the context of the system."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Time period during which identifier is/was valid for use."
},
"assigner": {
"$ref": "#/components/schemas/Reference",
"description": "Organization that issued/manages the identifier.",
"example": {
"reference": "Organization/123",
"type": "Organization",
"display": "The Assigning Organization"
}
}
}
}
]
},
"Money": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Numerical value (with implicit precision)."
},
"currency": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "ISO 4217 Currency Code."
}
}
}
]
},
"MoneyQuantity": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
},
{
"type": "object",
"properties": {
}
}
]
},
"Period": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"start": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The start of the period. The boundary is inclusive."
},
"end": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time."
}
}
}
]
},
"Quantity": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value."
},
"comparator": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "How the value should be understood and represented – whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value."
},
"unit": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A human–readable form of the unit."
},
"system": {
"type": "string",
"pattern": "\\S*",
"description": "The identification of the system that provides the coded form of the unit."
},
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A computer processable form of the unit in some unit representation system."
}
}
}
]
},
"Range": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"low": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The low limit. The boundary is inclusive."
},
"high": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The high limit. The boundary is inclusive."
}
}
}
]
},
"Ratio": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"numerator": {
"$ref": "#/components/schemas/Quantity",
"description": "The value of the numerator."
},
"denominator": {
"$ref": "#/components/schemas/Quantity",
"description": "The value of the denominator."
}
}
}
]
},
"Reference": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"reference": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources."
},
"type": {
"type": "string",
"pattern": "\\S*",
"description": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)."
},
"identifier": {
"$ref": "#/components/schemas/Identifier",
"description": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference."
},
"display": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Plain text narrative that identifies the resource in addition to the resource reference."
}
}
}
]
},
"SampledData": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"origin": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series."
},
"period": {
"type": "number",
"description": "The length of time between sampling times, measured in milliseconds."
},
"factor": {
"type": "number",
"description": "A correction factor that is applied to the sampled data points before they are added to the origin."
},
"lowerLimit": {
"type": "number",
"description": "The lower limit of detection of the measured points. This is needed if any of the data points have the value \"L\" (lower than detection limit)."
},
"upperLimit": {
"type": "number",
"description": "The upper limit of detection of the measured points. This is needed if any of the data points have the value \"U\" (higher than detection limit)."
},
"dimensions": {
"type": "integer",
"format": "int32",
"description": "The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced – all the sample points for a point in time will be recorded at once."
},
"data": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A series of data points which are decimal values separated by a single space (character u20). The special values \"E\" (error), \"L\" (below detection limit) and \"U\" (above detection limit) can also be used in place of a decimal value."
}
},
"required": [
"origin",
"period",
"dimensions"
]
}
]
},
"SimpleQuantity": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
},
{
"type": "object",
"properties": {
}
}
]
},
"Signature": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document."
},
"minItems": 1
},
"when": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "When the digital signature was signed."
},
"who": {
"$ref": "#/components/schemas/Reference",
"description": "A reference to an application–usable description of the identity that signed (e.g. the signature used their private key)."
},
"onBehalfOf": {
"$ref": "#/components/schemas/Reference",
"description": "A reference to an application–usable description of the identity that is represented by the signature."
},
"targetFormat": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A mime type that indicates the technical format of the target resources signed by the signature."
},
"sigFormat": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc."
},
"data": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty."
}
},
"required": [
"type",
"when",
"who"
]
}
]
},
"Timing": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"event": {
"type": "array",
"items": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Identifies specific times when the event occurs."
}
},
"repeat": {
"$ref": "#/components/schemas/Timing_Repeat",
"description": "A set of rules that describe when the event is scheduled."
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code)."
}
}
}
]
},
"Timing_Repeat": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"boundsDuration": {
"$ref": "#/components/schemas/Duration",
"description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule."
},
"boundsRange": {
"$ref": "#/components/schemas/Range",
"description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule."
},
"boundsPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule."
},
"count": {
"type": "integer",
"format": "int32",
"description": "A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values."
},
"countMax": {
"type": "integer",
"format": "int32",
"description": "If present, indicates that the count is a range – so to perform the action between [count] and [countMax] times."
},
"duration": {
"type": "number",
"description": "How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration."
},
"durationMax": {
"type": "number",
"description": "If present, indicates that the duration is a range – so to perform the action between [duration] and [durationMax] time length."
},
"durationUnit": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The units of time for the duration, in UCUM units."
},
"frequency": {
"type": "integer",
"format": "int32",
"description": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency."
},
"frequencyMax": {
"type": "integer",
"format": "int32",
"description": "If present, indicates that the frequency is a range – so to repeat between [frequency] and [frequencyMax] times within the period or period range."
},
"period": {
"type": "number",
"description": "Indicates the duration of time over which repetitions are to occur; e.g. to express \"3 times per day\", 3 would be the frequency and \"1 day\" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length."
},
"periodMax": {
"type": "number",
"description": "If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as \"do this once every 3–5 days."
},
"periodUnit": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The units of time for the period in UCUM units."
},
"dayOfWeek": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "If one or more days of week is provided, then the action happens only on the specified day(s)."
}
},
"timeOfDay": {
"type": "array",
"items": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "Specified time of day for action to take place."
}
},
"when": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur."
}
},
"offset": {
"type": "integer",
"format": "int32",
"description": "The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event."
}
}
}
]
},
"ContactDetail": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of an individual to contact."
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "The contact details for the individual (if a name was provided) or the organization."
}
}
}
}
]
},
"RelatedArtifact": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The type of relationship to the related artifact."
},
"label": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index."
},
"display": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer."
},
"citation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format."
},
"url": {
"type": "string",
"pattern": "\\S*",
"description": "A url for the artifact that can be followed to access the actual content."
},
"document": {
"$ref": "#/components/schemas/Attachment",
"description": "The document being referenced, represented as an attachment. This is exclusive with the resource element."
},
"resource": {
"type": "string",
"pattern": "\\S*",
"description": "The related resource, such as a library, value set, profile, or other knowledge resource."
}
},
"required": [
"type"
]
}
]
},
"UsageContext": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/Coding",
"description": "A code that identifies the type of context being specified by this usage context."
},
"valueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code."
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code."
},
"valueRange": {
"$ref": "#/components/schemas/Range",
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code."
},
"valueReference": {
"$ref": "#/components/schemas/Reference",
"description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code."
}
},
"required": [
"code"
]
}
]
},
"Meta": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"versionId": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted."
},
"lastUpdated": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "When the resource last changed – e.g. when the version changed."
},
"source": {
"type": "string",
"pattern": "\\S*",
"description": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc."
},
"profile": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition–definitions.html#StructureDefinition.url)."
}
},
"security": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure."
}
},
"tag": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource."
}
}
}
}
]
},
"Narrative": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of the narrative – whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data."
},
"div": {
"type": "string",
"description": "The actual narrative content, a stripped down version of XHTML."
}
},
"required": [
"status",
"div"
]
}
]
},
"Extension": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"pattern": "\\S*",
"description": "Source of the definition for the extension code – a logical name or a URL."
},
"valueBase64Binary": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueBoolean": {
"type": "boolean",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueCanonical": {
"type": "string",
"pattern": "\\S*",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueDecimal": {
"type": "number",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueId": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueInteger": {
"type": "integer",
"format": "int32",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueMarkdown": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueOid": {
"type": "string",
"pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valuePositiveInt": {
"type": "integer",
"format": "int32",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueUri": {
"type": "string",
"pattern": "\\S*",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueUrl": {
"type": "string",
"pattern": "\\S*",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueUuid": {
"type": "string",
"pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueAddress": {
"$ref": "#/components/schemas/Address",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueAge": {
"$ref": "#/components/schemas/Age",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueAnnotation": {
"$ref": "#/components/schemas/Annotation",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueCoding": {
"$ref": "#/components/schemas/Coding",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueContactPoint": {
"$ref": "#/components/schemas/ContactPoint",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueCount": {
"$ref": "#/components/schemas/Count",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueDistance": {
"$ref": "#/components/schemas/Distance",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueDuration": {
"$ref": "#/components/schemas/Duration",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueHumanName": {
"$ref": "#/components/schemas/HumanName",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueMoney": {
"$ref": "#/components/schemas/Money",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valuePeriod": {
"$ref": "#/components/schemas/Period",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueRange": {
"$ref": "#/components/schemas/Range",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueReference": {
"$ref": "#/components/schemas/Reference",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueSignature": {
"$ref": "#/components/schemas/Signature",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueTiming": {
"$ref": "#/components/schemas/Timing",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueContactDetail": {
"$ref": "#/components/schemas/ContactDetail",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueRelatedArtifact": {
"$ref": "#/components/schemas/RelatedArtifact",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueUsageContext": {
"$ref": "#/components/schemas/UsageContext",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
},
"valueMeta": {
"$ref": "#/components/schemas/Meta",
"description": "Value of extension – must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
}
},
"required": [
"url"
]
}
]
},
"CarePlan": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server."
}
},
"instantiatesCanonical": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to a FHIR–defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan."
}
},
"instantiatesUri": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan."
}
},
"basedOn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A care plan that is fulfilled in whole or in part by this care plan."
}
},
"replaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Completed or terminated care plan whose function is taken by this new care plan."
}
},
"partOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A larger care plan of which this particular care plan is a component or step."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record."
},
"intent": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies what \"kind\" of plan this is to support differentiation between multiple co–existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc."
}
},
"title": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Human–friendly name for the care plan."
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A description of the scope and nature of the plan."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the patient or group whose intended care is described by the plan."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Indicates when the plan did (or is intended to) come into effect and end."
},
"created": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Represents when this particular CarePlan record was created in the system, which is often a system–generated date."
},
"author": {
"$ref": "#/components/schemas/Reference",
"description": "When populated, the author is responsible for the care plan. The care plan is attributed to the author."
},
"contributor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the individual(s) or organization who provided the contents of the care plan."
}
},
"careTeam": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan."
}
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan."
}
},
"supportingInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc."
}
},
"goal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Describes the intended objective(s) of carrying out the care plan."
}
},
"activity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CarePlan_Activity",
"description": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self–monitoring, education, etc."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "General notes about the care plan not covered elsewhere."
}
}
},
"required": [
"status",
"intent",
"subject"
]
}
],
"example": {
"resourceType": "CarePlan",
"meta": {
"versionId": "HbagjWmeXL",
"lastUpdated": "2021-04-12T14:34:24.849-05:00",
"source": "BUocjyLjbT",
"profile": [
"X34xA0c7xx"
],
"security": [
{
"system": "cnIgpy7Ifv",
"version": "i9KKRAAzKP",
"code": "dFhJ3TKSVd",
"display": "ZgMvMLlXEW",
"userSelected": true
}
],
"tag": [
{
"system": "RvLOOuehV_",
"version": "rO3wjOqPc8",
"code": "C82Up7QQsZ",
"display": "hRXOzumbs4",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "rFSa0ySpYM",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "old",
"type": {
"coding": [
{
"system": "KQIg4LqEdI",
"version": "eE7XLfD1s_",
"code": "eI6J24VKX0",
"display": "sufbIO6P3h",
"userSelected": true
}
],
"text": "VMzD16UJEu"
},
"system": "BS5Sv8Bc7q",
"value": "73S9qhz57M",
"period": {
"start": "2021-04-12T14:34:24.838-05:00",
"end": "2021-04-12T14:34:24.839-05:00"
}
}
],
"instantiatesCanonical": [
"6IUYhHQPyy"
],
"instantiatesUri": [
"RiUZyRNoez"
],
"basedOn": [
{
"reference": "CarePlan/XRmIIEy3Cj",
"type": "CarePlan",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "5XqoyxbSOm",
"version": "lD52L13pm1",
"code": "L2sdZiIMc3",
"display": "WElyUEQ88E",
"userSelected": true
}
],
"text": "HogLZT7hNY"
},
"system": "ZtLtM6I0fJ",
"value": "7hmQGrFpXB",
"period": {
"start": "2021-04-12T14:34:24.83-05:00",
"end": "2021-04-12T14:34:24.83-05:00"
}
},
"display": "qGgBbSKPM4"
}
],
"replaces": [
{
"reference": "CarePlan/NPm8s-uiLJ",
"type": "CarePlan",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "Kv49FvgTrB",
"version": "ECiIhBkyKr",
"code": "1k0VSabSrG",
"display": "Jqiy4XuT5x",
"userSelected": true
}
],
"text": "gm1MkfTSf6"
},
"system": "y6B8BrZSK6",
"value": "ujcnRbTv68",
"period": {
"start": "2021-04-12T14:34:24.831-05:00",
"end": "2021-04-12T14:34:24.831-05:00"
}
},
"display": "Rm9jnOroKb"
}
],
"partOf": [
{
"reference": "CarePlan/ZESLuvLwGb",
"type": "CarePlan",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "Cnlw1CyCWk",
"version": "w3vnx56fA7",
"code": "qRXBz8zEuX",
"display": "czzAEUJJLJ",
"userSelected": true
}
],
"text": "1dx_am8zdO"
},
"system": "Psusjag_O5",
"value": "EimvBU5mLJ",
"period": {
"start": "2021-04-12T14:34:24.828-05:00",
"end": "2021-04-12T14:34:24.829-05:00"
}
},
"display": "fDqv8P0u5J"
}
],
"status": "on-hold",
"intent": "option",
"category": [
{
"coding": [
{
"system": "ZWfJhN07rZ",
"version": "uOThtHoInR",
"code": "nrHTmxXwVW",
"display": "3cSwxEXO7h",
"userSelected": true
}
],
"text": "Q4Dk6Qz1m2"
}
],
"title": "IPRVPR16Gy",
"description": "_qxCjc13JV",
"subject": {
"reference": "Patient/pTM5mChwQ8",
"type": "Patient",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "gh7m_C9El4",
"version": "xO91FuPEbb",
"code": "urhauZHNMg",
"display": "kKWwE2pkEt",
"userSelected": true
}
],
"text": "oeV2yYLfKJ"
},
"system": "htFMYX5R7V",
"value": "sw1oBg54w5",
"period": {
"start": "2021-04-12T14:34:24.846-05:00",
"end": "2021-04-12T14:34:24.846-05:00"
}
},
"display": "Uqmk6jvV8g"
},
"encounter": {
"reference": "Encounter/ZYU4FPf6k4",
"type": "Encounter",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "QBGhx6IZKm",
"version": "A9fk_cfK2H",
"code": "bxU8gt783z",
"display": "e1WkXmufiu",
"userSelected": true
}
],
"text": "226g2sW6yS"
},
"system": "76AuhwdVio",
"value": "fBriUgtK87",
"period": {
"start": "2021-04-12T14:34:24.847-05:00",
"end": "2021-04-12T14:34:24.847-05:00"
}
},
"display": "HWYkmJSETM"
},
"period": {
"start": "2021-04-12T14:34:24.832-05:00",
"end": "2021-04-12T14:34:24.833-05:00"
},
"created": "2021-04-12T14:34:24.828-05:00",
"author": {
"reference": "Patient/6rnBZ6yGoX",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "1Gn8rXMOEv",
"version": "aND7o7AFeU",
"code": "0aESosKCtq",
"display": "n4IIDTLsss",
"userSelected": true
}
],
"text": "gFY6cbOlbn"
},
"system": "Zi_BvIs5Oh",
"value": "2NS7IDCOhi",
"period": {
"start": "2021-04-12T14:34:24.827-05:00",
"end": "2021-04-12T14:34:24.827-05:00"
}
},
"display": "rmMKM_hUV9"
},
"contributor": [
{
"reference": "Patient/fEmkGxJ5BZ",
"type": "Patient",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "bEJI9VMLyK",
"version": "kMrYnKbGk7",
"code": "iNuZQ3XZm0",
"display": "DD8P1n1hvx",
"userSelected": true
}
],
"text": "4ZVNLICeVW"
},
"system": "KZkQhLNmmN",
"value": "QzcZuipDkE",
"period": {
"start": "2021-04-12T14:34:24.843-05:00",
"end": "2021-04-12T14:34:24.843-05:00"
}
},
"display": "7m5xddeudb"
}
],
"careTeam": [
{
"reference": "CareTeam/6s814x3Z1e",
"type": "CareTeam",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "cxSSTtwOcy",
"version": "trk5y6yKOf",
"code": "t44wLIv6tw",
"display": "_HnU9HiwHU",
"userSelected": true
}
],
"text": "Hm0en5uiEt"
},
"system": "z_ofspy9qr",
"value": "QOauYRSMaj",
"period": {
"start": "2021-04-12T14:34:24.84-05:00",
"end": "2021-04-12T14:34:24.84-05:00"
}
},
"display": "mxpsYL0T5L"
}
],
"addresses": [
{
"reference": "Condition/o7eVSjdJ7n",
"type": "Condition",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "affmBNdsvY",
"version": "fMPgejTo1A",
"code": "xt_XAENJir",
"display": "LtRVTq7wfP",
"userSelected": true
}
],
"text": "8BVTbrTK6C"
},
"system": "rfY7su9Mzu",
"value": "QjtD9tCHHJ",
"period": {
"start": "2021-04-12T14:34:24.848-05:00",
"end": "2021-04-12T14:34:24.848-05:00"
}
},
"display": "vAHB37Aofi"
}
],
"supportingInfo": [
{
"reference": "Basic/C3z1xbnBaO",
"type": "Basic",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "WgT3Evu9d6",
"version": "qeLUEJkIWO",
"code": "84lyhlBvTG",
"display": "H3KPCKd2p9",
"userSelected": true
}
],
"text": "YslayLMbU5"
},
"system": "SNcD7YPCf5",
"value": "pg5Ikmp7km",
"period": {
"start": "2021-04-12T14:34:24.837-05:00",
"end": "2021-04-12T14:34:24.837-05:00"
}
},
"display": "ojn1oCQDzS"
}
],
"goal": [
{
"reference": "Goal/IOuYsbmABQ",
"type": "Goal",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "w3qzks37L6",
"version": "FzgqggKH9C",
"code": "xBYClygtwi",
"display": "HA1ULVaIoK",
"userSelected": true
}
],
"text": "P1ySXi9s4M"
},
"system": "VQj8dJI4gX",
"value": "cOeSGV8aG8",
"period": {
"start": "2021-04-12T14:34:24.841-05:00",
"end": "2021-04-12T14:34:24.842-05:00"
}
},
"display": "q96HX0ZJ1a"
}
],
"activity": [
{
"outcomeCodeableConcept": [
{
"coding": [
{
"system": "Sry4FvBEVH",
"version": "vIB3brGck3",
"code": "yAo3CmHq_M",
"display": "fK9atZilIP",
"userSelected": true
}
],
"text": "p0Kyh1WvNU"
}
],
"outcomeReference": [
{
"reference": "Basic/6pSeJmEiLF",
"type": "Basic",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "vio_hhfIDT",
"version": "rhWbTdFvjk",
"code": "Eew3OzzK6G",
"display": "UYRZrRq25B",
"userSelected": true
}
],
"text": "ICLCjvwrcd"
},
"system": "TQjsFIAgD1",
"value": "6SCso6y5Gt",
"period": {
"start": "2021-04-12T14:34:24.834-05:00",
"end": "2021-04-12T14:34:24.834-05:00"
}
},
"display": "JZTfkDYGom"
}
],
"progress": [
{
"authorReference": {
"reference": "Practitioner/mOw4JXl-5L",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "DjQKiVUbsp",
"version": "ApVReeWylu",
"code": "H75I9i6N6n",
"display": "pFOyOmFiAA",
"userSelected": true
}
],
"text": "qcTjd5pfx9"
},
"system": "6p8sEYbLkA",
"value": "ZBYv7jXRCC",
"period": {
"start": "2021-04-12T14:34:24.836-05:00",
"end": "2021-04-12T14:34:24.836-05:00"
}
},
"display": "HdiTCN3xqI"
},
"time": "2021-04-12T14:34:24.836-05:00",
"text": "GkpTecuYFh"
}
],
"reference": {
"reference": "Appointment/Rh95gTrcrl",
"type": "Appointment",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "WR08GRcyS9",
"version": "Dn_6j6y_zm",
"code": "e1VrSePCeE",
"display": "DbPrdLFa6g",
"userSelected": true
}
],
"text": "8M74FvabKS"
},
"system": "GhDxTiER75",
"value": "UZH3t_L8V7",
"period": {
"start": "2021-04-12T14:34:24.835-05:00",
"end": "2021-04-12T14:34:24.835-05:00"
}
},
"display": "TmeK6H5ah_"
}
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/QlmmhF53G7",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "fD48NDccbM",
"version": "ottpoo9MZv",
"code": "op1_d2th7J",
"display": "5g7m8j7Ciu",
"userSelected": true
}
],
"text": "QkHLYVs0Vo"
},
"system": "4rbsMtwhH3",
"value": "nxKvnQEyXQ",
"period": {
"start": "2021-04-12T14:34:24.844-05:00",
"end": "2021-04-12T14:34:24.844-05:00"
}
},
"display": "akoLvryoYS"
},
"time": "2021-04-12T14:34:24.846-05:00",
"text": "dbFK9d_qb5"
}
]
}
},
"CarePlan_Activity": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"outcomeCodeableConcept": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not)."
}
},
"outcomeReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource)."
}
},
"progress": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Notes about the adherence/status/progress of the activity."
}
},
"reference": {
"$ref": "#/components/schemas/Reference",
"description": "The details of the proposed activity represented in a specific resource."
},
"detail": {
"$ref": "#/components/schemas/CarePlan_Activity_Detail",
"description": "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc."
}
}
}
]
},
"CarePlan_Activity_Detail": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A description of the kind of resource the in–line definition of a care plan activity is representing. The CarePlan.activity.detail is an in–line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest."
},
"instantiatesCanonical": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to a FHIR–defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity."
}
},
"instantiatesUri": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity."
}
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter."
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan."
}
},
"goal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies what progress is being made for the specific activity."
},
"statusReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc."
},
"doNotPerform": {
"type": "boolean",
"description": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan."
},
"scheduledTiming": {
"$ref": "#/components/schemas/Timing",
"description": "The period, timing or frequency upon which the described activity is to occur."
},
"scheduledPeriod": {
"$ref": "#/components/schemas/Period",
"description": "The period, timing or frequency upon which the described activity is to occur."
},
"scheduledString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The period, timing or frequency upon which the described activity is to occur."
},
"location": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc."
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies who's expected to be involved in the activity."
}
},
"productCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the food, drug or other product to be consumed or supplied in the activity."
},
"productReference": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the food, drug or other product to be consumed or supplied in the activity."
},
"dailyAmount": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "Identifies the quantity expected to be consumed in a given day."
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "Identifies the quantity expected to be supplied, administered or consumed by the subject."
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre–conditions and end–conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc."
}
},
"required": [
"status"
]
}
]
},
"CareTeam": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates the current state of the care team."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies what kind of team. This is to support differentiation between multiple co–existing teams, such as care plan team, episode of care team, longitudinal care team."
}
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the patient or group whose intended care is handled by the team."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Indicates when the team did (or is intended to) come into effect and end."
},
"participant": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CareTeam_Participant",
"description": "Identifies all people and organizations who are expected to be involved in the care team."
}
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Describes why the care team exists."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Condition(s) that this care team addresses."
}
},
"managingOrganization": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The organization responsible for the care team."
}
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "A central contact detail for the care team (that applies to all members)."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Comments made about the CareTeam."
}
}
}
}
],
"example": {
"resourceType": "CareTeam",
"meta": {
"versionId": "njttlNPv4d",
"lastUpdated": "2021-04-12T14:34:37.071-05:00",
"source": "kKFavC5AMK",
"profile": [
"UupLy7LvdW"
],
"security": [
{
"system": "plM0Bp4AkC",
"version": "Z6yOOq3gWG",
"code": "T0VQ8vKrsX",
"display": "qGLsOf0aAb",
"userSelected": true
}
],
"tag": [
{
"system": "P53TV9tK4M",
"version": "JuQIs0NhAR",
"code": "kwxZoctYhr",
"display": "1uCdfIf1HD",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "oRfuakauFI",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "old",
"type": {
"coding": [
{
"system": "qx6ygoTo63",
"version": "CFCAe0IqZ8",
"code": "yVPvH_QLyp",
"display": "etnpJS_liU",
"userSelected": true
}
],
"text": "EOAktY7vJX"
},
"system": "GrtgfR4YbD",
"value": "YnarKiezad",
"period": {
"start": "2021-04-12T14:34:37.065-05:00",
"end": "2021-04-12T14:34:37.066-05:00"
}
}
],
"status": "entered-in-error",
"category": [
{
"coding": [
{
"system": "h8o1lImOjJ",
"version": "5bqz17RFE9",
"code": "QIphVS3tpH",
"display": "JuwzvSMoOr",
"userSelected": true
}
],
"text": "QzOQvVX0SF"
}
],
"name": "1RGFQbj3c1",
"subject": {
"reference": "Patient/bHprStBDAf",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "6Db5Vs3Csy",
"version": "lqmQWTLnxM",
"code": "inR3tmiySy",
"display": "Og8ixZrAVL",
"userSelected": true
}
],
"text": "VxVrZamUc4"
},
"system": "zI6jdtuLSo",
"value": "RNXX3VfA3h",
"period": {
"start": "2021-04-12T14:34:37.067-05:00",
"end": "2021-04-12T14:34:37.067-05:00"
}
},
"display": "jcr7bgvSX3"
},
"encounter": {
"reference": "Encounter/jjNDu0Stus",
"type": "Encounter",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "r46G7tP3Z2",
"version": "bYeyRzsC56",
"code": "cM2cD9yjKu",
"display": "ja7LMcYFVT",
"userSelected": true
}
],
"text": "L0Tg_nDQkU"
},
"system": "0tw7PxCpMo",
"value": "lsPcFYK9dW",
"period": {
"start": "2021-04-12T14:34:37.068-05:00",
"end": "2021-04-12T14:34:37.068-05:00"
}
},
"display": "2PTbVmUKoe"
},
"period": {
"start": "2021-04-12T14:34:37.065-05:00",
"end": "2021-04-12T14:34:37.065-05:00"
},
"participant": [
{
"role": [
{
"coding": [
{
"system": "zU_ZjgbAuh",
"version": "3ou1upNXLJ",
"code": "gGphDM1lv2",
"display": "qd6vpRMtaI",
"userSelected": true
}
],
"text": "DleyP3Igb1"
}
],
"member": {
"reference": "Practitioner/n1JYV5a0K0",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "GhTad8z6gF",
"version": "jWqotfDbXF",
"code": "Fi_yNu0Lbz",
"display": "GSLZ0PVldM",
"userSelected": true
}
],
"text": "ZwWbMglHRL"
},
"system": "Byg89u74VW",
"value": "V9Ntb8gDJD",
"period": {
"start": "2021-04-12T14:34:37.065-05:00",
"end": "2021-04-12T14:34:37.065-05:00"
}
},
"display": "FzUpDEwRRn"
},
"onBehalfOf": {
"reference": "Organization/BrVksFvebv",
"type": "Organization",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "MAJ08orRK_",
"version": "Y4OSgCxORD",
"code": "aFota6tVmv",
"display": "qCDfykvsKI",
"userSelected": true
}
],
"text": "y257zP9jY9"
},
"system": "jMVEVFNebE",
"value": "G_S7tgnFRZ",
"period": {
"start": "2021-04-12T14:34:37.064-05:00",
"end": "2021-04-12T14:34:37.064-05:00"
}
},
"display": "I24Ukov6Xm"
},
"period": {
"start": "2021-04-12T14:34:37.064-05:00",
"end": "2021-04-12T14:34:37.064-05:00"
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "K9wcEyl_rn",
"version": "S1LnF_D_5l",
"code": "GibeIQrAja",
"display": "AUxiW1pTB8",
"userSelected": true
}
],
"text": "L6TjqBQpIl"
}
],
"reasonReference": [
{
"reference": "Condition/4nDhKZAmnG",
"type": "Condition",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "j372690h6I",
"version": "CGWQOqbJSM",
"code": "9KHO8nlA3p",
"display": "UjoafoRicU",
"userSelected": true
}
],
"text": "kV1X0avycd"
},
"system": "9MUjpDHzRJ",
"value": "1MLjdRiblm",
"period": {
"start": "2021-04-12T14:34:37.063-05:00",
"end": "2021-04-12T14:34:37.063-05:00"
}
},
"display": "pz3NDqmqqq"
}
],
"managingOrganization": [
{
"reference": "Organization/Z1Xi2cRe0E",
"type": "Organization",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "cqg2BwFQIS",
"version": "3N3BRzMrXd",
"code": "8w3Kc8DTbt",
"display": "8Hf7BL5yA8",
"userSelected": true
}
],
"text": "ruRvRGbWFm"
},
"system": "BV3IGjbIcz",
"value": "yClNvvBQSD",
"period": {
"start": "2021-04-12T14:34:37.069-05:00",
"end": "2021-04-12T14:34:37.069-05:00"
}
},
"display": "M_6EpPXxZU"
}
],
"telecom": [
{
"system": "phone",
"value": "loruq3XwVX",
"use": "old",
"rank": 1875857775,
"period": {
"start": "2021-04-12T14:34:37.067-05:00",
"end": "2021-04-12T14:34:37.067-05:00"
}
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/p8oh0ryxQu",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "Ez6RYZ9jZx",
"version": "I0RsqzTm1F",
"code": "EvwKawidai",
"display": "2u2UcLWJKl",
"userSelected": true
}
],
"text": "y6ujmWRAy4"
},
"system": "RBcgQtCJxL",
"value": "AXzZZ9OuGN",
"period": {
"start": "2021-04-12T14:34:37.066-05:00",
"end": "2021-04-12T14:34:37.066-05:00"
}
},
"display": "r1cnusm_5H"
},
"time": "2021-04-12T14:34:37.067-05:00",
"text": "42AnidH8z3"
}
]
}
},
"CareTeam_Participant": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"role": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc."
}
},
"member": {
"$ref": "#/components/schemas/Reference",
"description": "The specific person or organization who is participating/expected to participate in the care team."
},
"onBehalfOf": {
"$ref": "#/components/schemas/Reference",
"description": "The organization of the practitioner."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Indicates when the specific member or organization did (or is intended to) come into effect and end."
}
}
}
]
},
"CodeSystem": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system."
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance."
}
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation."
},
"title": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A short, descriptive, user–friendly title for the code system."
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The date (and optionally time) when the code system resource was created or revised."
},
"experimental": {
"type": "boolean",
"description": "A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes."
},
"publisher": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the organization or individual that published the code system."
},
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactDetail",
"description": "Contact details to assist a user in finding and communicating with the publisher."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A free text natural language description of the code system from a consumer's perspective."
},
"useContext": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageContext",
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances."
}
},
"jurisdiction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A legal or geographic region in which the code system is intended to be used."
}
},
"purpose": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Explanation of why this code system is needed and why it has been designed as it has."
},
"copyright": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system."
},
"caseSensitive": {
"type": "boolean",
"description": "If code comparison is case sensitive when codes within this system are compared to each other."
},
"valueSet": {
"type": "string",
"pattern": "\\S*",
"description": "Canonical reference to the value set that contains the entire code system."
},
"hierarchyMeaning": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The meaning of the hierarchy of concepts as represented in this resource."
},
"compositional": {
"type": "boolean",
"description": "The code system defines a compositional (post–coordination) grammar."
},
"versionNeeded": {
"type": "boolean",
"description": "This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system."
},
"content": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance."
},
"supplements": {
"type": "string",
"pattern": "\\S*",
"description": "The canonical URL of the code system that this code system supplement is adding designations and properties to."
},
"count": {
"type": "integer",
"format": "int32",
"description": "The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward."
},
"filter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeSystem_Filter",
"description": "A filter that can be used in a value set compose statement when selecting concepts using a filter."
}
},
"property": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeSystem_Property",
"description": "A property defines an additional slot through which additional information can be provided about a concept."
}
},
"concept": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeSystem_Concept",
"description": "Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are."
}
}
},
"required": [
"status",
"content"
]
}
],
"example": {
"resourceType": "CodeSystem",
"meta": {
"versionId": "jz64upZOBV",
"lastUpdated": "2021-04-12T14:34:33.268-05:00",
"source": "jIPQcAi5uW",
"profile": [
"lEfb_gHy14"
],
"security": [
{
"system": "9_APSA3sQi",
"version": "DspYfiY8HW",
"code": "KIo7fm2veb",
"display": "c8hbsNKrMX",
"userSelected": true
}
],
"tag": [
{
"system": "3Nh84OGo3l",
"version": "m5gyz4uNYh",
"code": "NLl1FXqxbL",
"display": "srZCV2bi13",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "GESpvmhWZt",
"language": "en-US",
"text": {
"status": "empty",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"url": "MUFCIAyI9x",
"identifier": [
{
"use": "temp",
"type": {
"coding": [
{
"system": "bGnFKwb4Qh",
"version": "uqTIOeDW2K",
"code": "qUWlGrhlum",
"display": "UAFTD2c_oL",
"userSelected": true
}
],
"text": "o8dzLBeMzx"
},
"system": "Xdq8Pwn1U5",
"value": "doc3_rFFhj",
"period": {
"start": "2021-04-12T14:34:33.259-05:00",
"end": "2021-04-12T14:34:33.26-05:00"
}
}
],
"version": "ZsvxusmyWV",
"name": "z2Y9sjjNjH",
"title": "kD21iMZocO",
"status": "unknown",
"experimental": true,
"date": "2021-04-12T14:34:33.267-05:00",
"publisher": "YGTYJIkXbr",
"contact": [
{
"name": "Rb8dZTPNBU",
"telecom": [
{
"system": "fax",
"value": "nwTWMLIf4y",
"use": "temp",
"rank": 2010880010,
"period": {
"start": "2021-04-12T14:34:33.261-05:00",
"end": "2021-04-12T14:34:33.261-05:00"
}
}
]
}
],
"description": "TGNCIylN49",
"useContext": [
{
"code": {
"system": "z17rJb3bCX",
"version": "v9zbAGpuuf",
"code": "Yzp1Aq2ud9",
"display": "jUnapHXzwK",
"userSelected": true
},
"valueCodeableConcept": {
"coding": [
{
"system": "TbE6x4DEDv",
"version": "SH4ZHGL_U0",
"code": "6K78JSNcjk",
"display": "bFcZw1aTop",
"userSelected": true
}
],
"text": "L212D77PeY"
}
}
],
"jurisdiction": [
{
"coding": [
{
"system": "7mcvhCsIQk",
"version": "YPtLShuxOQ",
"code": "X1b6D4ZGu3",
"display": "VhoLaDj8VV",
"userSelected": true
}
],
"text": "nAYOwPv3O8"
}
],
"purpose": "os4rVWGD9T",
"copyright": "Hs5Vl_3EWa",
"caseSensitive": true,
"valueSet": "oUbzATOZfo",
"hierarchyMeaning": "classified-with",
"compositional": true,
"versionNeeded": true,
"content": "supplement",
"supplements": "fB4gsyXBK8",
"count": 1949281088,
"filter": [
{
"code": "xSvObKuA9g",
"description": "scOjP8yNF_",
"operator": [
"is-a"
],
"value": "lX6yNNMXCp"
}
],
"property": [
{
"code": "v51DbPTQfL",
"uri": "Poiu4XSCjW",
"description": "iahfz_wDQt",
"type": "string"
}
],
"concept": [
{
"code": "SEE1xuwjJa",
"display": "H1xIO88N9K",
"definition": "xkL0TI4xMX",
"designation": [
{
"language": "en-US",
"use": {
"system": "CRQ0lEBf2p",
"version": "QgdcblkezS",
"code": "wKhHs5twJn",
"display": "_Ms7a2vfqW",
"userSelected": true
},
"value": "ObYuHkLuNB"
}
],
"property": [
{
"code": "gbutJMF0QL",
"valueCode": "eacnG8BdbU"
}
]
}
]
}
},
"CodeSystem_Concept": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code – a text symbol – that uniquely identifies the concept within the code system."
},
"display": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A human readable string that is the recommended default way to present this concept to a user."
},
"definition": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept."
},
"designation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeSystem_Concept_Designation",
"description": "Additional representations for the concept – other languages, aliases, specialized purposes, used for particular purposes, etc."
}
},
"property": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeSystem_Concept_Property",
"description": "A property value for this concept."
}
},
"concept": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeSystem_Concept",
"description": "Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is–a/contains/categorizes) – see hierarchyMeaning."
}
}
},
"required": [
"code"
]
}
]
},
"CodeSystem_Concept_Designation": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"language": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The language this designation is defined for."
},
"use": {
"$ref": "#/components/schemas/Coding",
"description": "A code that details how this designation would be used."
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The text value for this designation."
}
},
"required": [
"value"
]
}
]
},
"CodeSystem_Concept_Property": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters."
},
"valueCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The value of this property."
},
"valueCoding": {
"$ref": "#/components/schemas/Coding",
"description": "The value of this property."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The value of this property."
},
"valueInteger": {
"type": "integer",
"format": "int32",
"description": "The value of this property."
},
"valueBoolean": {
"type": "boolean",
"description": "The value of this property."
},
"valueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The value of this property."
},
"valueDecimal": {
"type": "number",
"description": "The value of this property."
}
},
"required": [
"code"
]
}
]
},
"CodeSystem_Filter": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter."
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A description of how or why the filter is used."
},
"operator": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A list of operators that can be used with the filter."
},
"minItems": 1
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A description of what the value for the filter should be."
}
},
"required": [
"code",
"operator",
"value"
]
}
]
},
"CodeSystem_Property": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters."
},
"uri": {
"type": "string",
"pattern": "\\S*",
"description": "Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem–concept–properties.html) code system."
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A description of the property– why it is defined, and how its value might be used."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The type of the property value. Properties of type \"code\" contain a code defined by the code system (e.g. a reference to another defined concept)."
}
},
"required": [
"code",
"type"
]
}
]
},
"Condition": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server."
}
},
"clinicalStatus": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The clinical status of the condition."
},
"verificationStatus": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The verification status to support the clinical status of the condition."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A category assigned to the condition."
}
},
"severity": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A subjective assessment of the severity of the condition as evaluated by the clinician."
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identification of the condition, problem or diagnosis."
},
"bodySite": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The anatomical location where this condition manifests itself."
}
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates the patient or group who the condition record is associated with."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The Encounter during which this Condition was created or to which the creation of this record is tightly associated."
},
"onsetDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Estimated or actual date or date–time the condition began, in the opinion of the clinician."
},
"onsetAge": {
"$ref": "#/components/schemas/Age",
"description": "Estimated or actual date or date–time the condition began, in the opinion of the clinician."
},
"onsetPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Estimated or actual date or date–time the condition began, in the opinion of the clinician."
},
"onsetRange": {
"$ref": "#/components/schemas/Range",
"description": "Estimated or actual date or date–time the condition began, in the opinion of the clinician."
},
"onsetString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Estimated or actual date or date–time the condition began, in the opinion of the clinician."
},
"abatementDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" – Conditions are never really resolved, but they can abate."
},
"abatementAge": {
"$ref": "#/components/schemas/Age",
"description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" – Conditions are never really resolved, but they can abate."
},
"abatementPeriod": {
"$ref": "#/components/schemas/Period",
"description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" – Conditions are never really resolved, but they can abate."
},
"abatementRange": {
"$ref": "#/components/schemas/Range",
"description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" – Conditions are never really resolved, but they can abate."
},
"abatementString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" – Conditions are never really resolved, but they can abate."
},
"recordedDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The recordedDate represents when this particular Condition record was created in the system, which is often a system–generated date."
},
"recorder": {
"$ref": "#/components/schemas/Reference",
"description": "Individual who recorded the record and takes responsibility for its content."
},
"asserter": {
"$ref": "#/components/schemas/Reference",
"description": "Individual who is making the condition statement."
},
"stage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition_Stage",
"description": "Clinical stage or grade of a condition. May include formal severity assessments."
}
},
"evidence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Condition_Evidence",
"description": "Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis."
}
}
},
"required": [
"subject"
]
}
],
"example": {
"resourceType": "Condition",
"meta": {
"versionId": "KL4FMa2hhR",
"lastUpdated": "2021-04-12T14:34:34.158-05:00",
"source": "yjTO_5UlpB",
"profile": [
"0YDUA_bOyy"
],
"security": [
{
"system": "JhBNtGqLjy",
"version": "8gtZciftEV",
"code": "GZEWD73cOo",
"display": "ZF00mbfLf3",
"userSelected": true
}
],
"tag": [
{
"system": "FGinsZBW9z",
"version": "Vy9YK0SaUR",
"code": "S4x31Xgltl",
"display": "uMk3fvxCvr",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "t3A9USo_Hm",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "old",
"type": {
"coding": [
{
"system": "RJBu5xEKq_",
"version": "eXjsx_LoHw",
"code": "6ohshiKUTd",
"display": "AwdCGUUo68",
"userSelected": true
}
],
"text": "VN1hOU7hYl"
},
"system": "YgD6wLk3iz",
"value": "jcO7AZakFQ",
"period": {
"start": "2021-04-12T14:34:34.148-05:00",
"end": "2021-04-12T14:34:34.149-05:00"
}
}
],
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"version": "4.0.1",
"code": "active",
"display": "Active",
"userSelected": false
}
],
"text": "active"
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"version": "4.0.1",
"code": "unconfirmed",
"display": "Unconfirmed",
"userSelected": false
}
],
"text": "unconfirmed"
},
"category": [
{
"coding": [
{
"system": "RUlZwtXqn_",
"version": "CwJWbdkTn4",
"code": "26qKRIYnwE",
"display": "klwJ9oIxpx",
"userSelected": true
}
],
"text": "UfX7CVaZWQ"
}
],
"severity": {
"coding": [
{
"system": "3rqKR_PNeH",
"version": "mr8ijX0lFx",
"code": "veKR4AjczL",
"display": "_Rdvp6F0EA",
"userSelected": true
}
],
"text": "V4q8GW84tB"
},
"code": {
"coding": [
{
"system": "sGYipa9PC9",
"version": "_UskUK69bc",
"code": "LWQOejVspX",
"display": "_bIcQia9cJ",
"userSelected": true
}
],
"text": "VM6unOzvx5"
},
"bodySite": [
{
"coding": [
{
"system": "88xVcQr3pJ",
"version": "4X_rcCgFP4",
"code": "fvRLEUCnLH",
"display": "Zleb_7Ende",
"userSelected": true
}
],
"text": "rk0LrGzoEJ"
}
],
"subject": {
"reference": "Patient/hH-zq0Zci6",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "so0mwwvUfj",
"version": "YS_HLsvpFm",
"code": "mwzNEvAFwb",
"display": "wRFjEOIsd1",
"userSelected": true
}
],
"text": "PCCxpDwmZ6"
},
"system": "G07b2Th5jH",
"value": "sRXUqHuRIL",
"period": {
"start": "2021-04-12T14:34:34.156-05:00",
"end": "2021-04-12T14:34:34.156-05:00"
}
},
"display": "JoyxNuuk1t"
},
"encounter": {
"reference": "Encounter/QINZRXprLS",
"type": "Encounter",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "TCJmC8an5d",
"version": "H41c85xpDg",
"code": "_Lee3LOMlW",
"display": "ntK1MSVeZe",
"userSelected": true
}
],
"text": "0pZMrLAFEj"
},
"system": "dOGocTQcD_",
"value": "HdbSdWO6vw",
"period": {
"start": "2021-04-12T14:34:34.157-05:00",
"end": "2021-04-12T14:34:34.157-05:00"
}
},
"display": "7Tjuf7w1nx"
},
"onsetDateTime": "2021-04-12T14:34:34.155-05:00",
"recordedDate": "2021-04-12T14:34:34.148-05:00",
"recorder": {
"reference": "Practitioner/U5S23Yp77A",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "Tz7cQjaeHG",
"version": "f0DnMCBSi7",
"code": "aolwlrn0Sf",
"display": "bea4h6Zsev",
"userSelected": true
}
],
"text": "atqcCYJqR6"
},
"system": "nzZwtroCAI",
"value": "rkeuKqpC6R",
"period": {
"start": "2021-04-12T14:34:34.146-05:00",
"end": "2021-04-12T14:34:34.147-05:00"
}
},
"display": "7Htf3ZUOIV"
},
"asserter": {
"reference": "Practitioner/LnrMu019uO",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "ZLe0lt6LrN",
"version": "9MdI0WLZ_d",
"code": "NMFnxPBwlp",
"display": "7XTSJMz6tJ",
"userSelected": true
}
],
"text": "PwPj0_9wYD"
},
"system": "LPb00JbodJ",
"value": "ImhS8KBix2",
"period": {
"start": "2021-04-12T14:34:34.154-05:00",
"end": "2021-04-12T14:34:34.154-05:00"
}
},
"display": "p93NwSrEzu"
},
"stage": [
{
"summary": {
"coding": [
{
"system": "PBeyRV1D8i",
"version": "NjxNYY3Ylm",
"code": "NhqFpWIpcp",
"display": "A61zqQTgyk",
"userSelected": true
}
],
"text": "yRzaUDAIFR"
},
"assessment": [
{
"reference": "ClinicalImpression/m3uMIrFGRl",
"type": "ClinicalImpression",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "1RsxYcVDnb",
"version": "t_7fgSmAMw",
"code": "PEqTZEHvbE",
"display": "37dUQ9k2ol",
"userSelected": true
}
],
"text": "leyM1XKkid"
},
"system": "4Wcg6jnOfl",
"value": "VTaaO4ngvs",
"period": {
"start": "2021-04-12T14:34:34.144-05:00",
"end": "2021-04-12T14:34:34.144-05:00"
}
},
"display": "auw8FgTP_w"
}
],
"type": {
"coding": [
{
"system": "usEY95ju1A",
"version": "tdsUGIFBCG",
"code": "5Xl9aQ8h33",
"display": "hDy3lhaolg",
"userSelected": true
}
],
"text": "QJiGnQrVWa"
}
}
],
"evidence": [
{
"code": [
{
"coding": [
{
"system": "g68WRevTZH",
"version": "DBxerIL_cQ",
"code": "m1Fdp49in7",
"display": "bAd_0lOTwf",
"userSelected": true
}
],
"text": "1Ym3pgzU5M"
}
],
"detail": [
{
"reference": "Basic/igqy7xMsLa",
"type": "Basic",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "jothtsrFXy",
"version": "hUsGCxRhiv",
"code": "YEfO3agg21",
"display": "P_hBjkjezG",
"userSelected": true
}
],
"text": "W9C1WQou6w"
},
"system": "PKapwjjUFh",
"value": "xTndbHngnT",
"period": {
"start": "2021-04-12T14:34:34.151-05:00",
"end": "2021-04-12T14:34:34.151-05:00"
}
},
"display": "Jn55tbIVz7"
}
]
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/7fmZw-ZXxv",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "Sm4iKcRnRY",
"version": "IiRDpWFwbM",
"code": "8aNN0Knup2",
"display": "Uyqd6M2apw",
"userSelected": true
}
],
"text": "cIRkSJii3N"
},
"system": "nc8e6TgBVu",
"value": "XZjbCIrzHe",
"period": {
"start": "2021-04-12T14:34:34.153-05:00",
"end": "2021-04-12T14:34:34.153-05:00"
}
},
"display": "Lf9MQopTW5"
},
"time": "2021-04-12T14:34:34.154-05:00",
"text": "3f5hGX_a0O"
}
]
}
},
"Condition_Evidence": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A manifestation or symptom that led to the recording of this condition."
}
},
"detail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Links to other relevant information, including pathology reports."
}
}
}
}
]
},
"Condition_Stage": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"summary": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease–specific."
},
"assessment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Reference to a formal record of the evidence on which the staging assessment is based."
}
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The kind of staging, such as pathological or clinical staging."
}
}
}
]
},
"Consent": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Unique identifier for this copy of the Consent Statement."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates the current state of this consent."
},
"scope": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements."
},
"minItems": 1
},
"patient": {
"$ref": "#/components/schemas/Reference",
"description": "The patient/healthcare consumer to whom this consent applies."
},
"dateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "When this Consent was issued / created / indexed."
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions."
}
},
"organization": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The organization that manages the consent, and the framework within which it is executed."
}
},
"sourceAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document."
},
"sourceReference": {
"$ref": "#/components/schemas/Reference",
"description": "The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document."
},
"policy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consent_Policy",
"description": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law."
}
},
"policyRule": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A reference to the specific base computable regulation or policy."
},
"verification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consent_Verification",
"description": "Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person."
}
},
"provision": {
"$ref": "#/components/schemas/Consent_Provision",
"description": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions."
}
},
"required": [
"status",
"scope",
"category"
]
}
],
"example": {
"resourceType": "Consent",
"meta": {
"versionId": "3sTCfPJsTU",
"lastUpdated": "2021-04-12T14:34:34.784-05:00",
"source": "kge7nBidPv",
"profile": [
"XCa58AvxpO"
],
"security": [
{
"system": "FwlLtnS1un",
"version": "fSthdGUk5K",
"code": "XlvAIHCf8A",
"display": "muHRxstlqf",
"userSelected": true
}
],
"tag": [
{
"system": "T7THYyOXqL",
"version": "Jcpm2ZJjmn",
"code": "ymoPeKkqhW",
"display": "4mXFigOXFn",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "Pyl9tGm6dP",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "secondary",
"type": {
"coding": [
{
"system": "Hi4QojGb3_",
"version": "I8XD45cEh5",
"code": "b3rQKEx2n9",
"display": "Vv7Ek0uyPG",
"userSelected": true
}
],
"text": "ubBzGsZDAp"
},
"system": "7hq6_6aRla",
"value": "ZZCzNiAoeq",
"period": {
"start": "2021-04-12T14:34:34.771-05:00",
"end": "2021-04-12T14:34:34.771-05:00"
}
}
],
"status": "rejected",
"scope": {
"coding": [
{
"system": "qCP49qauOX",
"version": "f1f60oco7V",
"code": "_G6s5V42UP",
"display": "Ix3ISWfNLf",
"userSelected": true
}
],
"text": "s2CTHhWTNa"
},
"category": [
{
"coding": [
{
"system": "OWpWy4DRCw",
"version": "0qNmiHAc_G",
"code": "XLAsKXU4PJ",
"display": "sAMpPDL9i_",
"userSelected": true
}
],
"text": "cV9E22uuD_"
}
],
"patient": {
"reference": "Patient/jNOAKVpBkg",
"type": "Patient",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "NyVhbOe5yS",
"version": "6myuCAAj_Y",
"code": "ioo7pOQDbZ",
"display": "CdWN2Snmwc",
"userSelected": true
}
],
"text": "kaUe4HIUL4"
},
"system": "dBHQbfcqPY",
"value": "_zbtzX_ShJ",
"period": {
"start": "2021-04-12T14:34:34.77-05:00",
"end": "2021-04-12T14:34:34.77-05:00"
}
},
"display": "bI8OqWirSH"
},
"dateTime": "2021-04-12T14:34:34.771-05:00",
"performer": [
{
"reference": "Organization/PwNh9evHG2",
"type": "Organization",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "jpumnVt5YT",
"version": "oMjdNMtEGH",
"code": "TUQlXSgwOm",
"display": "UoZs7yibK7",
"userSelected": true
}
],
"text": "aSFI7MW9Kr"
},
"system": "TjpOufCs6F",
"value": "i1QvC8Ad3U",
"period": {
"start": "2021-04-12T14:34:34.772-05:00",
"end": "2021-04-12T14:34:34.772-05:00"
}
},
"display": "w81Yatjwd4"
}
],
"organization": [
{
"reference": "Organization/2WApD1NKxP",
"type": "Organization",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "TlnQ78k9ix",
"version": "XOrTIW0_3y",
"code": "j0Te_t0lTY",
"display": "59lCY9bWVB",
"userSelected": true
}
],
"text": "OT5FGkpVgt"
},
"system": "7DqD_PiVJq",
"value": "b0MczpLNrh",
"period": {
"start": "2021-04-12T14:34:34.773-05:00",
"end": "2021-04-12T14:34:34.773-05:00"
}
},
"display": "dc2L8OwQ2m"
}
],
"sourceAttachment": {
"contentType": "5ERMZP4mz7",
"language": "en-US",
"data": "CiN9EXQ=",
"url": "IwfBht0ojS",
"size": 279718729,
"hash": "G0oGWi8=",
"title": "epzaxG6_Gu",
"creation": "2021-04-12T14:34:34.784-05:00"
},
"policy": [
{
"authority": "9EbHXQK414",
"uri": "L9Zu53Maz5"
}
],
"policyRule": {
"coding": [
{
"system": "iZCA0sdnkY",
"version": "TSF1BvaCCh",
"code": "OHZcd18_Kk",
"display": "xF8Q4udkdv",
"userSelected": true
}
],
"text": "txIJsZBc4A"
},
"verification": [
{
"verified": true,
"verifiedWith": {
"reference": "Patient/yIYnAaopby",
"type": "Patient",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "v49L0SAEd_",
"version": "A_8xOhfzxA",
"code": "IJ2vlD3Woc",
"display": "pjEaw5wOsQ",
"userSelected": true
}
],
"text": "HTvsLSUyxL"
},
"system": "nfGLCb9Hs7",
"value": "VP3KgJ1Jf6",
"period": {
"start": "2021-04-12T14:34:34.768-05:00",
"end": "2021-04-12T14:34:34.768-05:00"
}
},
"display": "iC7jL07jxV"
},
"verificationDate": "2021-04-12T14:34:34.769-05:00"
}
],
"provision": {
"type": "permit",
"period": {
"start": "2021-04-12T14:34:34.776-05:00",
"end": "2021-04-12T14:34:34.776-05:00"
},
"actor": [
{
"role": {
"coding": [
{
"system": "mLyPzUDv2R",
"version": "YYddwAWJiT",
"code": "qpdMdzLOJg",
"display": "dFRctMkpUi",
"userSelected": true
}
],
"text": "fFu3I8Z37_"
},
"reference": {
"reference": "Device/Z--uUfc4LG",
"type": "Device",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "dhDp_PxW1N",
"version": "fb8GVixBtg",
"code": "M99eMZAXDG",
"display": "S3gL2gQMPk",
"userSelected": true
}
],
"text": "CJInv9nbGn"
},
"system": "lL301ObrVK",
"value": "O18_GL4sfe",
"period": {
"start": "2021-04-12T14:34:34.781-05:00",
"end": "2021-04-12T14:34:34.781-05:00"
}
},
"display": "tadKnoFoO_"
}
}
],
"action": [
{
"coding": [
{
"system": "pq8AX4vu29",
"version": "IRzSVxWBuB",
"code": "7WTEO3sr13",
"display": "wKB29P_3co",
"userSelected": true
}
],
"text": "B2L_HzY7gd"
}
],
"securityLabel": [
{
"system": "OC50jTL9Cp",
"version": "GgmBTwzwbV",
"code": "q2rq4nDomr",
"display": "fFvvOlHXW6",
"userSelected": true
}
],
"purpose": [
{
"system": "DucBnaa6du",
"version": "GyBm9C7fPw",
"code": "2KyisX5rxr",
"display": "7N9PAHWzd3",
"userSelected": true
}
],
"class": [
{
"system": "xk90VmoN2g",
"version": "QiFTbLGcp7",
"code": "qPAsUoxUAs",
"display": "yHpOg2HRnH",
"userSelected": true
}
],
"code": [
{
"coding": [
{
"system": "Go5s0OSfGc",
"version": "dlhQxDxFQB",
"code": "7OLMRdq218",
"display": "Y5UXTVvnIl",
"userSelected": true
}
],
"text": "Nvuuzyc0W7"
}
],
"dataPeriod": {
"start": "2021-04-12T14:34:34.775-05:00",
"end": "2021-04-12T14:34:34.775-05:00"
},
"data": [
{
"meaning": "related",
"reference": {
"reference": "Basic/OhTBOd2Xnt",
"type": "Basic",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "k_hELT2Yv3",
"version": "blA2eZF5Bc",
"code": "jsf5e41Do1",
"display": "LHKJbpxvh0",
"userSelected": true
}
],
"text": "ZTsxgP8Sku"
},
"system": "4LvhV6QiiH",
"value": "zxQCHCHCtd",
"period": {
"start": "2021-04-12T14:34:34.777-05:00",
"end": "2021-04-12T14:34:34.777-05:00"
}
},
"display": "oHypug16_4"
}
}
]
}
}
},
"Consent_Policy": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"authority": {
"type": "string",
"pattern": "\\S*",
"description": "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives."
},
"uri": {
"type": "string",
"pattern": "\\S*",
"description": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law."
}
}
}
]
},
"Consent_Provision": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Action to take – permit or deny – when the rule conditions are met. Not permitted in root rule, required in all nested rules."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The timeframe in this rule is valid."
},
"actor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consent_Provision_Actor",
"description": "Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers')."
}
},
"action": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Actions controlled by this Rule."
}
},
"securityLabel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception."
}
},
"purpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "The context of the activities a user is taking – why the user is accessing the data – that are controlled by this rule."
}
},
"class": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to."
}
},
"code": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "If this code is found in an instance, then the rule applies."
}
},
"dataPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Clinical or Operational Relevant period of time that bounds the data controlled by this rule."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consent_Provision_Data",
"description": "The resources controlled by this rule if specific resources are referenced."
}
},
"provision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Consent_Provision",
"description": "Rules which provide exceptions to the base rule or subrules."
}
}
}
}
]
},
"Consent_Provision_Actor": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"role": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "How the individual is involved in the resources content that is described in the exception."
},
"reference": {
"$ref": "#/components/schemas/Reference",
"description": "The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers')."
}
},
"required": [
"role",
"reference"
]
}
]
},
"Consent_Provision_Data": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"meaning": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "How the resource reference is interpreted when testing consent restrictions."
},
"reference": {
"$ref": "#/components/schemas/Reference",
"description": "A reference to a specific resource that defines which resources are covered by this consent."
}
},
"required": [
"meaning",
"reference"
]
}
]
},
"Consent_Verification": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"verified": {
"type": "boolean",
"description": "Has the instruction been verified."
},
"verifiedWith": {
"$ref": "#/components/schemas/Reference",
"description": "Who verified the instruction (Patient, Relative or other Authorized Person)."
},
"verificationDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Date verification was collected."
}
},
"required": [
"verified"
]
}
]
},
"Coverage": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A unique identifier assigned to this coverage."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of the resource instance."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization."
},
"policyHolder": {
"$ref": "#/components/schemas/Reference",
"description": "The party who 'owns' the insurance policy."
},
"subscriber": {
"$ref": "#/components/schemas/Reference",
"description": "The party who has signed–up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due."
},
"subscriberId": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The insurer assigned ID for the Subscriber."
},
"beneficiary": {
"$ref": "#/components/schemas/Reference",
"description": "The party who benefits from the insurance coverage; the patient when products and/or services are provided."
},
"dependent": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A unique identifier for a dependent under the coverage."
},
"relationship": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The relationship of beneficiary (patient) to the subscriber."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force."
},
"payor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The program or plan underwriter or payor including both insurance and non–insurance agreements, such as patient–pay agreements."
},
"minItems": 1
},
"class": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coverage_Class",
"description": "A suite of underwriter specific classifiers."
}
},
"order": {
"type": "integer",
"format": "int32",
"description": "The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care."
},
"network": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The insurer–specific identifier for the insurer–defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in–network' rate, otherwise 'out of network' terms and conditions apply."
},
"costToBeneficiary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coverage_CostToBeneficiary",
"description": "A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card."
}
},
"subrogation": {
"type": "boolean",
"description": "When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs."
},
"contract": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The policy(s) which constitute this insurance coverage."
}
}
},
"required": [
"status",
"beneficiary",
"payor"
]
}
],
"example": {
"resourceType": "Coverage",
"meta": {
"versionId": "ZoBEPrYBKs",
"lastUpdated": "2021-04-12T14:34:31.166-05:00",
"source": "bKHUeU_0rQ",
"profile": [
"HxppGaau8o"
],
"security": [
{
"system": "ZNY_kRKuW5",
"version": "IiBKfyRLCx",
"code": "EV3I23xb26",
"display": "gIHiJPkNIS",
"userSelected": true
}
],
"tag": [
{
"system": "1L3qLM82U4",
"version": "jucS46b4SX",
"code": "Ku_8TWv9x_",
"display": "eEBuDr7k8B",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "2TOC4ScVpE",
"language": "en-US",
"text": {
"status": "empty",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "0KwA_cJUAe",
"version": "AjcD8UPnlc",
"code": "eVK_ixSgux",
"display": "n1K8Z85kb2",
"userSelected": true
}
],
"text": "YG_kRXmMfH"
},
"system": "meeA6F7pRW",
"value": "Xbb7LYXCn2",
"period": {
"start": "2021-04-12T14:34:31.154-05:00",
"end": "2021-04-12T14:34:31.155-05:00"
}
}
],
"status": "cancelled",
"type": {
"coding": [
{
"system": "tA4fVAp14T",
"version": "CkvKjgUb3g",
"code": "Ti2bj9f9AB",
"display": "Kv9SPApe8G",
"userSelected": true
}
],
"text": "iSqtghamvo"
},
"policyHolder": {
"reference": "Patient/-VyJOI5Wan",
"type": "Patient",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "QHCOyGdYaL",
"version": "P10RFtReSP",
"code": "AFtR_I6x56",
"display": "9wUfku_kX3",
"userSelected": true
}
],
"text": "SypbVoKRaS"
},
"system": "l59lauWbV6",
"value": "zsjeSDN5lS",
"period": {
"start": "2021-04-12T14:34:31.158-05:00",
"end": "2021-04-12T14:34:31.158-05:00"
}
},
"display": "QG0wgeu4ht"
},
"subscriber": {
"reference": "Patient/Y49Pp-ggy2",
"type": "Patient",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "IHU9fsdgeN",
"version": "5kX3znBVTV",
"code": "ZNWEiODqYq",
"display": "PHqoOKYjdF",
"userSelected": true
}
],
"text": "g_avL4LxDt"
},
"system": "RoDEoFBZxO",
"value": "L5ZpwNNXxi",
"period": {
"start": "2021-04-12T14:34:31.163-05:00",
"end": "2021-04-12T14:34:31.164-05:00"
}
},
"display": "y4D4InJqPz"
},
"subscriberId": "JGI93tb8xz",
"beneficiary": {
"reference": "Patient/BOu9xisJnQ",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "_3YQcO_NgB",
"version": "CTDQOTF2Ku",
"code": "bcclJEGJZW",
"display": "qGg9e8D3PV",
"userSelected": true
}
],
"text": "wOvYnTanvy"
},
"system": "5jbHlewH75",
"value": "kqtV1Ipi8U",
"period": {
"start": "2021-04-12T14:34:31.159-05:00",
"end": "2021-04-12T14:34:31.159-05:00"
}
},
"display": "_8M5fXuE2D"
},
"dependent": "yvoNVPzxY2",
"relationship": {
"coding": [
{
"system": "0ebNAyQ26S",
"version": "9SdxMGhLHU",
"code": "nJykZWHPYy",
"display": "OYycRhROZ_",
"userSelected": true
}
],
"text": "bqGSHFR4GU"
},
"period": {
"start": "2021-04-12T14:34:31.154-05:00",
"end": "2021-04-12T14:34:31.154-05:00"
},
"payor": [
{
"reference": "Organization/YOjGyFwwH2",
"type": "Organization",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "GZBFDpjq25",
"version": "qyGGjG_oHq",
"code": "gMubRQ6F3c",
"display": "0OZmUjiWIa",
"userSelected": true
}
],
"text": "pXTuscELhf"
},
"system": "sxlgBbcz_6",
"value": "3i4JoyBCbp",
"period": {
"start": "2021-04-12T14:34:31.157-05:00",
"end": "2021-04-12T14:34:31.157-05:00"
}
},
"display": "RNMgxmBF88"
}
],
"class": [
{
"type": {
"coding": [
{
"system": "daCam_crD7",
"version": "Rq_fW4Qagh",
"code": "Z72D4kHraO",
"display": "8za9V3caMK",
"userSelected": true
}
],
"text": "9pfUErCAWg"
},
"value": "QHMLRRkKjV",
"name": "0kffNz1Lgc"
}
],
"order": 312447222,
"network": "5rqKOGyouh",
"costToBeneficiary": [
{
"type": {
"coding": [
{
"system": "nm0bWMODJs",
"version": "MznZH8PhEE",
"code": "DKlgXaszcp",
"display": "FtYOAIRvCI",
"userSelected": true
}
],
"text": "_sD3agmzBX"
},
"valueQuantity": {
"value": 447723829856,
"unit": "foF14wa4dB",
"system": "ZNtHmnFJLj",
"code": "NKk4Bu4eyY"
},
"exception": [
{
"type": {
"coding": [
{
"system": "h941Ivq6jb",
"version": "HGz55Mack8",
"code": "ItAJqqVN7r",
"display": "8Zsnb8anFy",
"userSelected": true
}
],
"text": "QCN2mQgA9x"
},
"period": {
"start": "2021-04-12T14:34:31.161-05:00",
"end": "2021-04-12T14:34:31.161-05:00"
}
}
]
}
],
"subrogation": true,
"contract": [
{
"reference": "Contract/xkSes41GOn",
"type": "Contract",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "qAIuhvxuIH",
"version": "S83SGDtnQq",
"code": "_HmFHzIPXg",
"display": "Y2ZJQc_Ztt",
"userSelected": true
}
],
"text": "6a_X1yJsZR"
},
"system": "9ovDZBSObP",
"value": "EdLvEZAeZY",
"period": {
"start": "2021-04-12T14:34:31.156-05:00",
"end": "2021-04-12T14:34:31.156-05:00"
}
},
"display": "Dx8x7tADoX"
}
]
}
},
"Coverage_Class": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type of classification for which an insurer–specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan."
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The alphanumeric string value associated with the insurer issued label."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A short description for the class."
}
},
"required": [
"type",
"value"
]
}
]
},
"Coverage_CostToBeneficiary": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The category of patient centric costs associated with treatment."
},
"valueQuantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The amount due from the patient for the cost category."
},
"valueMoney": {
"$ref": "#/components/schemas/Money",
"description": "The amount due from the patient for the cost category."
},
"exception": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coverage_CostToBeneficiary_Exception",
"description": "A suite of codes indicating exceptions or reductions to patient costs and their effective periods."
}
}
}
}
]
},
"Coverage_CostToBeneficiary_Exception": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The code for the specific exception."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The timeframe during when the exception is in force."
}
},
"required": [
"type"
]
}
]
},
"Device": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Unique instance identifiers assigned to a device by manufacturers other organizations or owners."
}
},
"definition": {
"$ref": "#/components/schemas/Reference",
"description": "The reference to the definition for the device."
},
"udiCarrier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device_UdiCarrier",
"description": "Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Status of the Device availability."
},
"statusReason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Reason for the dtatus of the Device availability."
}
},
"distinctIdentifier": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue–based product."
},
"manufacturer": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A name of the manufacturer."
},
"manufactureDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date and time when the device was manufactured."
},
"expirationDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date and time beyond which this device is no longer valid or should not be used (if applicable)."
},
"lotNumber": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Lot number assigned by the manufacturer."
},
"serialNumber": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The serial number assigned by the organization when the device was manufactured."
},
"deviceName": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device_DeviceName",
"description": "This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition."
}
},
"modelNumber": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The model number for the device."
},
"partNumber": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The part number of the device."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName."
},
"specialization": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device_Specialization",
"description": "The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication."
}
},
"version": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device_Version",
"description": "The version of the standard that is used to operate and communicate."
}
},
"property": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device_Property",
"description": "The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties."
}
},
"patient": {
"$ref": "#/components/schemas/Reference",
"description": "Patient information, If the device is affixed to a person."
},
"owner": {
"$ref": "#/components/schemas/Reference",
"description": "An organization that is responsible for the provision and ongoing maintenance of the device."
},
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "Contact details for an organization or a particular human that is responsible for the device."
}
},
"location": {
"$ref": "#/components/schemas/Reference",
"description": "The place where the device can be found."
},
"url": {
"type": "string",
"pattern": "\\S*",
"description": "A network address on which the device may be contacted directly."
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Descriptive information, usage information or implantation information that is not captured in an existing element."
}
},
"safety": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Provides additional safety characteristics about a medical device. For example devices containing latex."
}
},
"parent": {
"$ref": "#/components/schemas/Reference",
"description": "The parent device."
}
}
}
],
"example": {
"resourceType": "Device",
"meta": {
"versionId": "x6fYsyfU40",
"lastUpdated": "2021-04-12T14:34:35.934-05:00",
"source": "a4YK3eoOxQ",
"profile": [
"0slRrm9gHi"
],
"security": [
{
"system": "QhTUOqix3n",
"version": "uPTnVgRXjk",
"code": "eHaRIspzDz",
"display": "rYjVMKEmEj",
"userSelected": true
}
],
"tag": [
{
"system": "FVbirzb_i8",
"version": "MyOlSvBAhh",
"code": "xMdsuz9UEw",
"display": "N7ebiLW8w_",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "90CMg0KW4h",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "CIln8ZO9wM",
"version": "l1fs8JXzt1",
"code": "Z5U572rwsW",
"display": "7tSxBNl_zv",
"userSelected": true
}
],
"text": "Brbou7CMa4"
},
"system": "yrUY1Ppz8z",
"value": "Fabdr2ThVC",
"period": {
"start": "2021-04-12T14:34:35.921-05:00",
"end": "2021-04-12T14:34:35.921-05:00"
}
}
],
"definition": {
"reference": "DeviceDefinition/BYU7DB6Ncr",
"type": "DeviceDefinition",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "3UEln8OBE0",
"version": "A0t1f3iUSP",
"code": "AwSt27WllG",
"display": "NcNBxvxCAW",
"userSelected": true
}
],
"text": "D2QMewKl1h"
},
"system": "MYl7iZYkl4",
"value": "zB0Q0I2IT2",
"period": {
"start": "2021-04-12T14:34:35.919-05:00",
"end": "2021-04-12T14:34:35.919-05:00"
}
},
"display": "I5s9Un9pE5"
},
"udiCarrier": [
{
"deviceIdentifier": "EmW_EF_IrO",
"issuer": "PnokDa2sxf",
"jurisdiction": "cQV48H_jaM",
"carrierAIDC": "EScpGyI=",
"carrierHRF": "tv0tWVRo7D",
"entryType": "card"
}
],
"status": "active",
"statusReason": [
{
"coding": [
{
"system": "Vk2m5zhp0x",
"version": "EViTHZbhyA",
"code": "Cax_7iNYBq",
"display": "S3kV_n8vAe",
"userSelected": true
}
],
"text": "263DP2dlgt"
}
],
"distinctIdentifier": "rtWqA0HQSV",
"manufacturer": "TweZAZWHw5",
"manufactureDate": "2021-04-12T14:34:35.924-05:00",
"expirationDate": "2021-04-12T14:34:35.925-05:00",
"lotNumber": "IXfPY_3FAf",
"serialNumber": "PS5B_xn0WN",
"deviceName": [
{
"name": "SkTfuaen3F",
"type": "patient-reported-name"
}
],
"modelNumber": "dJpesngMZ8",
"partNumber": "5kn0zp1z7O",
"type": {
"coding": [
{
"system": "Y0T3XtTspa",
"version": "UnQknGlybm",
"code": "w3tqP_BMOu",
"display": "GsHXagDqJo",
"userSelected": true
}
],
"text": "q0nFiTVDkw"
},
"specialization": [
{
"systemType": {
"coding": [
{
"system": "zdA28Oo94i",
"version": "ojEIBeWgdB",
"code": "j_YqAooyob",
"display": "LsTgueGzOS",
"userSelected": true
}
],
"text": "O82p16Lzjn"
},
"version": "xtEDWBABjK"
}
],
"version": [
{
"type": {
"coding": [
{
"system": "1n9xvDTv6q",
"version": "DHcdkp1Nik",
"code": "BZxkWu5qJV",
"display": "BLqZieqABE",
"userSelected": true
}
],
"text": "jxKDaZVrV6"
},
"component": {
"use": "usual",
"type": {
"coding": [
{
"system": "SuRDEWYp3P",
"version": "QLQkXlKf4j",
"code": "eGuNj0Y4i4",
"display": "MX1LkcRH6y",
"userSelected": true
}
],
"text": "fDBTpMc71h"
},
"system": "7s4WWRmAS5",
"value": "tqVkzJNyPo",
"period": {
"start": "2021-04-12T14:34:35.933-05:00",
"end": "2021-04-12T14:34:35.933-05:00"
}
},
"value": "bj63SwqWwu"
}
],
"property": [
{
"type": {
"coding": [
{
"system": "5fvoZplQ6g",
"version": "UIugMCH932",
"code": "lx2DSuuGMB",
"display": "7BiuCVhFRI",
"userSelected": true
}
],
"text": "exjC3yLtFB"
},
"valueQuantity": [
{
"value": 335345252361,
"comparator": ">=",
"unit": "SsWqB8PNe7",
"system": "nknXzeeymx",
"code": "GwIXDFKcud"
}
],
"valueCode": [
{
"coding": [
{
"system": "XDu6g0R6se",
"version": "OPTCf_CmbJ",
"code": "EWwMVVPUPq",
"display": "zrK_gVvJ4v",
"userSelected": true
}
],
"text": "HGm077SGXz"
}
]
}
],
"patient": {
"reference": "Patient/uKZkfHKq2T",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "_zkJa2ZC1e",
"version": "GYwIA18BUS",
"code": "_u6siStITm",
"display": "bpQQlVXWiY",
"userSelected": true
}
],
"text": "PDDqfu1nOH"
},
"system": "DAAHA9DzTy",
"value": "qRC2BnzrNR",
"period": {
"start": "2021-04-12T14:34:35.92-05:00",
"end": "2021-04-12T14:34:35.92-05:00"
}
},
"display": "On6FuY0anf"
},
"owner": {
"reference": "Organization/9Lixo46IQj",
"type": "Organization",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "JJ8Rbl3CqZ",
"version": "B88bsuqotT",
"code": "S1T44FX_Ot",
"display": "HxkqCrjrEu",
"userSelected": true
}
],
"text": "4bH5VXuTQu"
},
"system": "kkCswy82KK",
"value": "f3zyi610RQ",
"period": {
"start": "2021-04-12T14:34:35.922-05:00",
"end": "2021-04-12T14:34:35.922-05:00"
}
},
"display": "yCjueoHjzE"
},
"contact": [
{
"system": "other",
"value": "rrKFkcLjSq",
"use": "temp",
"rank": 1078593785,
"period": {
"start": "2021-04-12T14:34:35.928-05:00",
"end": "2021-04-12T14:34:35.928-05:00"
}
}
],
"location": {
"reference": "Location/3GQyGHC9TI",
"type": "Location",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "LWKvFW3O3L",
"version": "RWNrpAB__B",
"code": "NdX7lXo53A",
"display": "n9QKLB8TWC",
"userSelected": true
}
],
"text": "PiH3a_j00S"
},
"system": "0tM5Amh8b4",
"value": "BYk2YLLBqC",
"period": {
"start": "2021-04-12T14:34:35.932-05:00",
"end": "2021-04-12T14:34:35.932-05:00"
}
},
"display": "VdC5vWRnkf"
},
"url": "JYTWGuV4Wf",
"note": [
{
"authorReference": {
"reference": "Practitioner/qj0HBnlLUC",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "4NgUV5j3PW",
"version": "1nnAB5k3Ue",
"code": "bRn92cfmuX",
"display": "qv_Blvzm2c",
"userSelected": true
}
],
"text": "4uoZJn3RsG"
},
"system": "bnPiBahu3W",
"value": "4PRU0tN8Ac",
"period": {
"start": "2021-04-12T14:34:35.927-05:00",
"end": "2021-04-12T14:34:35.927-05:00"
}
},
"display": "sEE8TAnlSo"
},
"time": "2021-04-12T14:34:35.928-05:00",
"text": "LbiSGR2BGp"
}
],
"safety": [
{
"coding": [
{
"system": "9ohCX_LjOu",
"version": "hBQrAhOuAX",
"code": "IQBnWs9UMo",
"display": "kDdTUwtRI8",
"userSelected": true
}
],
"text": "JQO0_kZ_eV"
}
],
"parent": {
"reference": "Device/P3dKnumx4X",
"type": "Device",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "vjaIe9E8am",
"version": "MHTxtqEDXP",
"code": "0WTqEKZakK",
"display": "gvSRMT2f_S",
"userSelected": true
}
],
"text": "RQjF3DrgRT"
},
"system": "k0KZoO6L7E",
"value": "i0VZdX1x83",
"period": {
"start": "2021-04-12T14:34:35.93-05:00",
"end": "2021-04-12T14:34:35.93-05:00"
}
},
"display": "VAmoOx8cdx"
}
}
},
"Device_DeviceName": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the device."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName."
}
},
"required": [
"name",
"type"
]
}
]
},
"Device_Property": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Code that specifies the property DeviceDefinitionPropetyCode (Extensible)."
},
"valueQuantity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Quantity",
"description": "Property value as a quantity."
}
},
"valueCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Property value as a code, e.g., NTP4 (synced to NTP)."
}
}
},
"required": [
"type"
]
}
]
},
"Device_Specialization": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"systemType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The standard that is used to operate and communicate."
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The version of the standard that is used to operate and communicate."
}
},
"required": [
"systemType"
]
}
]
},
"Device_UdiCarrier": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"deviceIdentifier": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device."
},
"issuer": {
"type": "string",
"pattern": "\\S*",
"description": "Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :\n1) GS1: \nhttp://hl7.org/fhir/NamingSystem/gs1–di, \n2) HIBCC:\nhttp://hl7.org/fhir/NamingSystem/hibcc–dI, \n3) ICCBBA for blood containers:\nhttp://hl7.org/fhir/NamingSystem/iccbba–blood–di, \n4) ICCBA for other devices:\nhttp://hl7.org/fhir/NamingSystem/iccbba–other–di."
},
"jurisdiction": {
"type": "string",
"pattern": "\\S*",
"description": "The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda–udi."
},
"carrierAIDC": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device – e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round–trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded."
},
"carrierHRF": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device."
},
"entryType": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A coded entry to indicate how the data was entered."
}
}
}
]
},
"Device_Version": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type of the device version."
},
"component": {
"$ref": "#/components/schemas/Identifier",
"description": "A single component of the device version."
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The version text."
}
},
"required": [
"value"
]
}
]
},
"Group": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A unique business identifier for this group."
}
},
"active": {
"type": "boolean",
"description": "Indicates whether the record for the group is available for use or is merely being retained for historical purposes."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies the broad classification of the kind of resources the group includes."
},
"actual": {
"type": "boolean",
"description": "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals."
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A label assigned to the group for human identification and communication."
},
"quantity": {
"type": "integer",
"format": "int32",
"description": "A count of the number of resource instances that are part of the group."
},
"managingEntity": {
"$ref": "#/components/schemas/Reference",
"description": "Entity responsible for defining and maintaining Group characteristics and/or registered members."
},
"characteristic": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group_Characteristic",
"description": "Identifies traits whose presence r absence is shared by members of the group."
}
},
"member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group_Member",
"description": "Identifies the resource instances that are members of the group."
}
}
},
"required": [
"type",
"actual"
]
}
],
"example": {
"resourceType": "Group",
"meta": {
"versionId": "tGDgvoJqAY",
"lastUpdated": "2021-04-12T14:34:33.382-05:00",
"source": "5EgBM6JHvr",
"profile": [
"dM2LuwQvRl"
],
"security": [
{
"system": "VzTHFwfXHu",
"version": "5rdyUQoRWd",
"code": "tHmygBlcWZ",
"display": "kxt6w4UQNr",
"userSelected": true
}
],
"tag": [
{
"system": "WWkZaQZp0V",
"version": "gVO8_q54Xu",
"code": "uYhcrsE697",
"display": "389ieg3fPY",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "xKp38XwcZZ",
"language": "en-US",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "c_gNSC1s3v",
"version": "v4t_69YfwF",
"code": "sVcl5tST8N",
"display": "2eBy5KXkHG",
"userSelected": true
}
],
"text": "uvUr_hDqHJ"
},
"system": "P7YidHhXJQ",
"value": "vyuKNI9THu",
"period": {
"start": "2021-04-12T14:34:33.378-05:00",
"end": "2021-04-12T14:34:33.378-05:00"
}
}
],
"active": true,
"type": "person",
"actual": true,
"code": {
"coding": [
{
"system": "bqNiaNS6Y8",
"version": "L7ZtCos7c5",
"code": "4ZEDjVc0hX",
"display": "1wY7CSE8Vo",
"userSelected": true
}
],
"text": "YHaRB9USBT"
},
"name": "HPJbhw1ZK_",
"quantity": 1652875650,
"managingEntity": {
"reference": "Organization/qGEaX-nMXp",
"type": "Organization",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "tzVilglU6t",
"version": "aDXaopSd_e",
"code": "c0fVNMbT08",
"display": "PG3okTGuso",
"userSelected": true
}
],
"text": "m3Asou39qX"
},
"system": "No2e1VaqFC",
"value": "kORuXGZii4",
"period": {
"start": "2021-04-12T14:34:33.379-05:00",
"end": "2021-04-12T14:34:33.379-05:00"
}
},
"display": "mu9f1KlbM2"
},
"characteristic": [
{
"code": {
"coding": [
{
"system": "LwEgKo2P0I",
"version": "WJZYAItZwP",
"code": "4XiHIqsgpw",
"display": "yp4RujLZgE",
"userSelected": true
}
],
"text": "X4ph3MXmQT"
},
"valueCodeableConcept": {
"coding": [
{
"system": "H0YQlGeyX9",
"version": "7ZzXjoUmWA",
"code": "hv6yeX7p3j",
"display": "MTMkqo9l1t",
"userSelected": true
}
],
"text": "IItMxJPBv7"
},
"exclude": true,
"period": {
"start": "2021-04-12T14:34:33.377-05:00",
"end": "2021-04-12T14:34:33.377-05:00"
}
}
],
"member": [
{
"entity": {
"reference": "Patient/QqfbXliohT",
"type": "Patient",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "nblZSlHjiT",
"version": "yQ5QH7TgYx",
"code": "BuyEKu2_G6",
"display": "P99whuimuK",
"userSelected": true
}
],
"text": "NBZMJkv5f1"
},
"system": "cs3vkotI1x",
"value": "bbVfBmDp7E",
"period": {
"start": "2021-04-12T14:34:33.381-05:00",
"end": "2021-04-12T14:34:33.381-05:00"
}
},
"display": "cAUTzgKMmf"
},
"period": {
"start": "2021-04-12T14:34:33.38-05:00",
"end": "2021-04-12T14:34:33.381-05:00"
},
"inactive": true
}
]
}
},
"Group_Characteristic": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code that identifies the kind of trait being asserted."
},
"valueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The value of the trait that holds (or does not hold – see 'exclude') for members of the group."
},
"valueBoolean": {
"type": "boolean",
"description": "The value of the trait that holds (or does not hold – see 'exclude') for members of the group."
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The value of the trait that holds (or does not hold – see 'exclude') for members of the group."
},
"valueRange": {
"$ref": "#/components/schemas/Range",
"description": "The value of the trait that holds (or does not hold – see 'exclude') for members of the group."
},
"valueReference": {
"$ref": "#/components/schemas/Reference",
"description": "The value of the trait that holds (or does not hold – see 'exclude') for members of the group."
},
"exclude": {
"type": "boolean",
"description": "If true, indicates the characteristic is one that is NOT held by members of the group."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June."
}
},
"required": [
"code",
"exclude"
]
}
]
},
"Group_Member": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/Reference",
"description": "A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The period that the member was in the group, if known."
},
"inactive": {
"type": "boolean",
"description": "A flag to indicate that the member is no longer in the group, but previously may have been a member."
}
},
"required": [
"entity"
]
}
]
},
"Provenance": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"target": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity."
},
"minItems": 1
},
"occurredPeriod": {
"$ref": "#/components/schemas/Period",
"description": "The period during which the activity occurred."
},
"occurredDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The period during which the activity occurred."
},
"recorded": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The instant of time at which the activity was recorded."
},
"policy": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc."
}
},
"location": {
"$ref": "#/components/schemas/Reference",
"description": "Where the activity occurred, if relevant."
},
"reason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The reason that the activity was taking place."
}
},
"activity": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities."
},
"agent": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provenance_Agent",
"description": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place."
},
"minItems": 1
},
"entity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provenance_Entity",
"description": "An entity used in this activity."
}
},
"signature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signature",
"description": "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated."
}
}
},
"required": [
"target",
"recorded",
"agent"
]
}
],
"example": {
"resourceType": "Provenance",
"meta": {
"versionId": "e0jdZTrrK6",
"lastUpdated": "2021-04-12T14:34:34.822-05:00",
"source": "Tb0RM7HAOJ",
"profile": [
"RvRSWxcGiJ"
],
"security": [
{
"system": "Oq4xCKTMyp",
"version": "xvkLKIDs_B",
"code": "cc9B3UkIG5",
"display": "zMs3iz4CUH",
"userSelected": true
}
],
"tag": [
{
"system": "fcoxCsSKkg",
"version": "FkPGxGMALj",
"code": "DyfRzEQzQv",
"display": "YrZbdETwnq",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "5FSROU1kIH",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"target": [
{
"reference": "Basic/raveQEvZns",
"type": "Basic",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "jR6epFYmsN",
"version": "BaTxyFSIAA",
"code": "oaIwkRnbsG",
"display": "Ab39FrDSbI",
"userSelected": true
}
],
"text": "6m62XllQQm"
},
"system": "rcpR8wkCpd",
"value": "feXgUB1Iup",
"period": {
"start": "2021-04-12T14:34:34.82-05:00",
"end": "2021-04-12T14:34:34.82-05:00"
}
},
"display": "gbwkwVX6AW"
}
],
"occurredPeriod": {
"start": "2021-04-12T14:34:34.828-05:00",
"end": "2021-04-12T14:34:34.828-05:00"
},
"recorded": "2021-04-12T14:34:34.814-05:00",
"policy": [
"PU3QGACQd5"
],
"location": {
"reference": "Location/jfAGiJiwc3",
"type": "Location",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "w5DPqSOidH",
"version": "F6mQuIXdJ5",
"code": "FkgpyQU_sC",
"display": "RPTz6WiI5r",
"userSelected": true
}
],
"text": "2UzgLVeKGP"
},
"system": "3W_Wqmt1YO",
"value": "_xH6TWCTM8",
"period": {
"start": "2021-04-12T14:34:34.821-05:00",
"end": "2021-04-12T14:34:34.821-05:00"
}
},
"display": "45clWLzum0"
},
"reason": [
{
"coding": [
{
"system": "guUYE0b07P",
"version": "EktqPjf7NG",
"code": "ONx2ggbpY2",
"display": "mfytxQ4bmq",
"userSelected": true
}
],
"text": "jHnpfZN7DH"
}
],
"activity": {
"coding": [
{
"system": "NEzry2pw2s",
"version": "ISpBxO9_l0",
"code": "VVt7SI6RvK",
"display": "0Xlexycj34",
"userSelected": true
}
],
"text": "DMCClGoG06"
},
"agent": [
{
"type": {
"coding": [
{
"system": "eWEqiBwg5P",
"version": "WvELfe76cQ",
"code": "gQaomB3Z_Y",
"display": "sLeZxQtqRV",
"userSelected": true
}
],
"text": "NdFfZKm4Sv"
},
"role": [
{
"coding": [
{
"system": "R5kDA7o7y_",
"version": "LEGmDZ6IKA",
"code": "JjMCfWI9n0",
"display": "b24ZuGKKvB",
"userSelected": true
}
],
"text": "brG_nusweR"
}
],
"who": {
"reference": "Practitioner/spE-Z7Ujs8",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "bFSs0qySzF",
"version": "QrZITI1QcO",
"code": "zxw00cfCmb",
"display": "lokZpEzE1y",
"userSelected": true
}
],
"text": "Fn1nzJxSFb"
},
"system": "5TciYXoCbb",
"value": "r8Y4m1QJqJ",
"period": {
"start": "2021-04-12T14:34:34.815-05:00",
"end": "2021-04-12T14:34:34.816-05:00"
}
},
"display": "9LW3Oy6HeS"
},
"onBehalfOf": {
"reference": "Practitioner/u8Ry06KmoZ",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "tlzTw7DauJ",
"version": "2kQDdatVzL",
"code": "mb8yJqxKf3",
"display": "n7ekqKkEo6",
"userSelected": true
}
],
"text": "uVB6KjEkGq"
},
"system": "twfyEkpayh",
"value": "nePRkGikX6",
"period": {
"start": "2021-04-12T14:34:34.814-05:00",
"end": "2021-04-12T14:34:34.815-05:00"
}
},
"display": "wZFOwI_YRB"
}
}
],
"entity": [
{
"role": "revision",
"what": {
"reference": "Basic/JN91VxsjxR",
"type": "Basic",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "BbY5Yk5fO8",
"version": "szm56_yCpa",
"code": "WicpBkW7T3",
"display": "Gsz3g4k9c0",
"userSelected": true
}
],
"text": "YbBj0Mgx3M"
},
"system": "PmJsygWi7G",
"value": "Eiu2HysrXt",
"period": {
"start": "2021-04-12T14:34:34.827-05:00",
"end": "2021-04-12T14:34:34.827-05:00"
}
},
"display": "9Xb_G0bsXH"
},
"agent": [
{
"type": {
"coding": [
{
"system": "gBHtso4NYY",
"version": "wiAeguouhr",
"code": "m3QQLT6ByB",
"display": "FfMqfD9Aal",
"userSelected": true
}
],
"text": "sTjXEHoz7j"
},
"role": [
{
"coding": [
{
"system": "0PZLqDpqFx",
"version": "OMzINOJsHD",
"code": "DN3KTTLOrs",
"display": "22NkoIqvpU",
"userSelected": true
}
],
"text": "vc05oTGy0_"
}
],
"who": {
"reference": "Practitioner/qWM760B3d1",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "44izdPe98g",
"version": "QW53BMzNYR",
"code": "Rh__wVdZyq",
"display": "nwzrJd3wZW",
"userSelected": true
}
],
"text": "Q9z2nXpPEs"
},
"system": "KJkPd0J53w",
"value": "KAqn14GcZt",
"period": {
"start": "2021-04-12T14:34:34.826-05:00",
"end": "2021-04-12T14:34:34.826-05:00"
}
},
"display": "3YPTaZbMUV"
},
"onBehalfOf": {
"reference": "Practitioner/4UEARmrMfx",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "PE151CMUek",
"version": "FMB9FuLvR2",
"code": "zzJTPpHIIQ",
"display": "5e_ROKiBbz",
"userSelected": true
}
],
"text": "9sksJPX5pZ"
},
"system": "2G0xMPU6Jh",
"value": "Vxla9K4IJG",
"period": {
"start": "2021-04-12T14:34:34.825-05:00",
"end": "2021-04-12T14:34:34.825-05:00"
}
},
"display": "c5lRTkVC7_"
}
}
]
}
],
"signature": [
{
"type": [
{
"system": "29ZHQk3uyh",
"version": "ZujOuYvRe3",
"code": "r6GdbUeoX2",
"display": "1_hc_nuOpR",
"userSelected": true
}
],
"when": "2021-04-12T14:34:34.819-05:00",
"who": {
"reference": "Practitioner/yboqPHOvPg",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "r0QZoOtDos",
"version": "R1hlq6ZUvD",
"code": "NPLa4G5glO",
"display": "DyRrpvN_5Q",
"userSelected": true
}
],
"text": "OrskqWVZaV"
},
"system": "Ozv6sTBk3B",
"value": "urjo6wwlq5",
"period": {
"start": "2021-04-12T14:34:34.819-05:00",
"end": "2021-04-12T14:34:34.819-05:00"
}
},
"display": "2OOHJZY8rI"
},
"onBehalfOf": {
"reference": "Practitioner/FwL3DG9XHd",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "sz9NYls0zi",
"version": "ulw0DJEt66",
"code": "CFJRYgVICf",
"display": "hzRXF1uQeC",
"userSelected": true
}
],
"text": "9dc4cOPoa7"
},
"system": "IB8kleg1Mv",
"value": "OAFpScUD2g",
"period": {
"start": "2021-04-12T14:34:34.818-05:00",
"end": "2021-04-12T14:34:34.818-05:00"
}
},
"display": "oxFHyrPgvX"
},
"targetFormat": "Edrw69SYoh",
"sigFormat": "eJX3l1Yd93",
"data": "Rh1fGx4="
}
]
}
},
"Provenance_Agent": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The participation the agent had with respect to the activity."
},
"role": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity."
}
},
"who": {
"$ref": "#/components/schemas/Reference",
"description": "The individual, device or organization that participated in the event."
},
"onBehalfOf": {
"$ref": "#/components/schemas/Reference",
"description": "The individual, device, or organization for whom the change was made."
}
},
"required": [
"who"
]
}
]
},
"Provenance_Entity": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"role": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "How the entity was used during the activity."
},
"what": {
"$ref": "#/components/schemas/Reference",
"description": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative."
},
"agent": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provenance_Agent",
"description": "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity."
}
}
},
"required": [
"role",
"what"
]
}
]
},
"DiagnosticReport": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifiers assigned to this report by the performer or other systems."
}
},
"basedOn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Details concerning a service requested."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of the diagnostic report."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes."
}
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code or name that describes this diagnostic report."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about."
},
"effectiveDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The time or time–period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself."
},
"effectivePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The time or time–period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself."
},
"issued": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified."
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The diagnostic service that is responsible for issuing the report."
}
},
"resultsInterpreter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The practitioner or organization that is responsible for the report's conclusions and interpretations."
}
},
"specimen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Details about the specimens on which this diagnostic report is based."
}
},
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "[Observations](observation.html) that are part of this diagnostic report."
}
},
"imagingStudy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images."
}
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiagnosticReport_Media",
"description": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest)."
}
},
"conclusion": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report."
},
"conclusionCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report."
}
},
"presentedForm": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment",
"description": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent."
}
}
},
"required": [
"status",
"code"
]
}
],
"example": {
"resourceType": "DiagnosticReport",
"meta": {
"versionId": "goytEDx9gN",
"lastUpdated": "2021-04-12T14:34:34.621-05:00",
"source": "bQlq51SkyB",
"profile": [
"k2_sNPSL0I"
],
"security": [
{
"system": "ASXxwAWwMk",
"version": "76T1szHHof",
"code": "6XMvQcWgr5",
"display": "jfTkXE7jrT",
"userSelected": true
}
],
"tag": [
{
"system": "OmovtwGPip",
"version": "39Ij5L2J1Q",
"code": "3i_rkrLEvE",
"display": "DC6IUynxve",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "UWy3RSPFxE",
"language": "en-US",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "temp",
"type": {
"coding": [
{
"system": "xf9PbMMnQE",
"version": "eZV8DJqz_k",
"code": "C1GpFK6uIR",
"display": "JdSr_DgZPC",
"userSelected": true
}
],
"text": "w1Fpy378H0"
},
"system": "5ttvoV2O5F",
"value": "9jO8FpxN8a",
"period": {
"start": "2021-04-12T14:34:34.614-05:00",
"end": "2021-04-12T14:34:34.614-05:00"
}
}
],
"basedOn": [
{
"reference": "CarePlan/VMib3h9dKX",
"type": "CarePlan",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "PhSSc3BbAv",
"version": "26SpirX306",
"code": "9wtZvN_dx2",
"display": "wSf0PDpqdB",
"userSelected": true
}
],
"text": "K7L4NQRhF8"
},
"system": "_Zciqa1INR",
"value": "Ozt_zH8E7d",
"period": {
"start": "2021-04-12T14:34:34.611-05:00",
"end": "2021-04-12T14:34:34.611-05:00"
}
},
"display": "FmJVBVFv9n"
}
],
"status": "registered",
"category": [
{
"coding": [
{
"system": "uyasgvIAkL",
"version": "CVpPiD_GA3",
"code": "ZmC6_sxU2O",
"display": "OtgUJ_MuXN",
"userSelected": true
}
],
"text": "yIv8bbnJnU"
}
],
"code": {
"coding": [
{
"system": "PU7W93JmW_",
"version": "iwRJ4aJmQF",
"code": "7VrnYnLAYj",
"display": "1cLyN8q5pl",
"userSelected": true
}
],
"text": "mDqiNJS2C7"
},
"subject": {
"reference": "Patient/4g3znmUFtG",
"type": "Patient",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "SnUrrPHGXH",
"version": "Rr3ZH3wJLN",
"code": "vold5nWRe4",
"display": "h2h6EJjtd2",
"userSelected": true
}
],
"text": "aZODBp7ps4"
},
"system": "e_5jC6JuIf",
"value": "Kp2MKK3vfE",
"period": {
"start": "2021-04-12T14:34:34.618-05:00",
"end": "2021-04-12T14:34:34.618-05:00"
}
},
"display": "h_2z6JyR7a"
},
"encounter": {
"reference": "Encounter/cmavmo1sYV",
"type": "Encounter",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "uwdkia1Bj3",
"version": "m7tFikywEC",
"code": "Hofq6fV7Vt",
"display": "xwjrcRKmy2",
"userSelected": true
}
],
"text": "EX9ipoM8TF"
},
"system": "EZR7CRmpGB",
"value": "D3LlbW3fhy",
"period": {
"start": "2021-04-12T14:34:34.619-05:00",
"end": "2021-04-12T14:34:34.619-05:00"
}
},
"display": "bmXIi4GW3X"
},
"effectiveDateTime": "2021-04-12T14:34:34.62-05:00",
"issued": "2021-04-12T14:34:34.62-05:00",
"performer": [
{
"reference": "Practitioner/LQ6jkjGU3U",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "caQjBp_wTW",
"version": "rnXHfmmjmt",
"code": "VOpH3uN8F0",
"display": "Bkaq0eZG8v",
"userSelected": true
}
],
"text": "1TwriRjMNF"
},
"system": "RWbUPR1Rfx",
"value": "1Fx3ITDCG4",
"period": {
"start": "2021-04-12T14:34:34.617-05:00",
"end": "2021-04-12T14:34:34.618-05:00"
}
},
"display": "wrfrxn7qd0"
}
],
"resultsInterpreter": [
{
"reference": "Practitioner/sHchcuF1NA",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "gncrwZyna9",
"version": "hBWEdQWvKO",
"code": "3RZfUBkWxM",
"display": "lK1AbtHIiA",
"userSelected": true
}
],
"text": "fNKCJkpYPT"
},
"system": "RBsQfwR75E",
"value": "BbwPh1E3FP",
"period": {
"start": "2021-04-12T14:34:34.612-05:00",
"end": "2021-04-12T14:34:34.612-05:00"
}
},
"display": "OY7IZL_kul"
}
],
"specimen": [
{
"reference": "Specimen/rYoc8MVQE-",
"type": "Specimen",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "iPajw_he32",
"version": "VeiullSO3r",
"code": "6wH_WJTizJ",
"display": "3IgsyGEuqV",
"userSelected": true
}
],
"text": "qgXABMZidn"
},
"system": "TLk2vxzazh",
"value": "9oYhGgQN73",
"period": {
"start": "2021-04-12T14:34:34.617-05:00",
"end": "2021-04-12T14:34:34.617-05:00"
}
},
"display": "hYJkDVcCte"
}
],
"result": [
{
"reference": "Observation/J7jAJXrxst",
"type": "Observation",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "VaaDtfL5jj",
"version": "4k0Q9fhp2E",
"code": "uD7Mt9NMK3",
"display": "U9vJTi_Jig",
"userSelected": true
}
],
"text": "YlrGFzZrWO"
},
"system": "u54gmp87Mu",
"value": "uWSIn5JCH5",
"period": {
"start": "2021-04-12T14:34:34.62-05:00",
"end": "2021-04-12T14:34:34.62-05:00"
}
},
"display": "Tpj6w2OOlW"
}
],
"imagingStudy": [
{
"reference": "ImagingStudy/8VHX2r3XEC",
"type": "ImagingStudy",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "ryzxpTDEt9",
"version": "zDVby1jRqs",
"code": "BIUaMMCh_P",
"display": "wjpIhm_cqs",
"userSelected": true
}
],
"text": "HCwAkgZXuw"
},
"system": "WZcjh4WrDp",
"value": "3npdWOlpb4",
"period": {
"start": "2021-04-12T14:34:34.615-05:00",
"end": "2021-04-12T14:34:34.615-05:00"
}
},
"display": "qkwpLOZtux"
}
],
"media": [
{
"comment": "d3jeswb_Mr",
"link": {
"reference": "Media/9kJD03IyNE",
"type": "Media",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "X44PnCUtha",
"version": "GwPIlKhDKm",
"code": "erZky8mE6w",
"display": "1PL9sbumFv",
"userSelected": true
}
],
"text": "paJ6Jwq2VJ"
},
"system": "SUIWyl6VEZ",
"value": "VBKYjnV2F5",
"period": {
"start": "2021-04-12T14:34:34.616-05:00",
"end": "2021-04-12T14:34:34.616-05:00"
}
},
"display": "281yiEx6Wt"
}
}
],
"conclusion": "lC1T9aXOCL",
"conclusionCode": [
{
"coding": [
{
"system": "kY8WcBFHgI",
"version": "5_iN2GZbR7",
"code": "tpj8Jyb1PK",
"display": "fXaEI3znom",
"userSelected": true
}
],
"text": "_EPtWOfAe4"
}
],
"presentedForm": [
{
"contentType": "kq17L_YXTp",
"language": "en-US",
"data": "IRhFCgk=",
"url": "iJtARB3QWV",
"size": 1795627287,
"hash": "ej1RQXs=",
"title": "eCgDH4CWYt",
"creation": "2021-04-12T14:34:34.613-05:00"
}
]
}
},
"DiagnosticReport_Media": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features."
},
"link": {
"$ref": "#/components/schemas/Reference",
"description": "Reference to the image source."
}
},
"required": [
"link"
]
}
]
},
"ExplanationOfBenefit": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A unique identifier assigned to this explanation of benefit."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of the resource instance."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The category of claim, e.g. oral, pharmacy, vision, institutional, professional."
},
"subType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service."
},
"use": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non–binding adjudication of the listed products and services which could be provided in the future."
},
"patient": {
"$ref": "#/components/schemas/Reference",
"description": "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought."
},
"billablePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The period for which charges are being submitted."
},
"created": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date this resource was created."
},
"enterer": {
"$ref": "#/components/schemas/Reference",
"description": "Individual who created the claim, predetermination or preauthorization."
},
"insurer": {
"$ref": "#/components/schemas/Reference",
"description": "The party responsible for authorization, adjudication and reimbursement."
},
"provider": {
"$ref": "#/components/schemas/Reference",
"description": "The provider which is responsible for the claim, predetermination or preauthorization."
},
"priority": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The provider–required urgency of processing the request. Typical values include: stat, routine deferred."
},
"fundsReserveRequested": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code to indicate whether and for whom funds are to be reserved for future claims."
},
"fundsReserve": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom."
},
"related": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Related",
"description": "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event."
}
},
"prescription": {
"$ref": "#/components/schemas/Reference",
"description": "Prescription to support the dispensing of pharmacy, device or vision products."
},
"originalPrescription": {
"$ref": "#/components/schemas/Reference",
"description": "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products."
},
"payee": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Payee",
"description": "The party to be reimbursed for cost of the products and services according to the terms of the policy."
},
"referral": {
"$ref": "#/components/schemas/Reference",
"description": "A reference to a referral resource."
},
"facility": {
"$ref": "#/components/schemas/Reference",
"description": "Facility where the services were provided."
},
"claim": {
"$ref": "#/components/schemas/Reference",
"description": "Reference to a related claim."
},
"claimResponse": {
"$ref": "#/components/schemas/Reference",
"description": "The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response."
},
"outcome": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The outcome of the claim, predetermination, or preauthorization processing."
},
"disposition": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A human readable description of the status of the adjudication."
},
"preAuthRef": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Reference from the Insurer which is used in later communications which refers to this adjudication."
}
},
"preAuthRefPeriod": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Period",
"description": "The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided."
}
},
"careTeam": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_CareTeam",
"description": "The members of the team who provided the products and services."
}
},
"supportingInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_SupportingInfo",
"description": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues."
}
},
"diagnosis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Diagnosis",
"description": "Information about diagnoses relevant to the claim items."
}
},
"procedure": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Procedure",
"description": "Procedures performed on the patient relevant to the billing items with the claim."
}
},
"precedence": {
"type": "integer",
"format": "int32",
"description": "This indicates the relative order of a series of EOBs related to different coverages for the same suite of services."
},
"insurance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Insurance",
"description": "Financial instruments for reimbursement for the health care products and services specified on the claim."
},
"minItems": 1
},
"accident": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Accident",
"description": "Details of a accident which resulted in injuries which required the products and services listed in the claim."
},
"item": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item",
"description": "A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub–details."
}
},
"addItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_AddItem",
"description": "The first–tier service adjudications for payor added product or service lines."
}
},
"adjudication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Adjudication",
"description": "If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item."
}
},
"total": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Total",
"description": "Categorized monetary totals for the adjudication."
}
},
"payment": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Payment",
"description": "Payment details for the adjudication of the claim."
},
"formCode": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code for the form to be used for printing the content."
},
"form": {
"$ref": "#/components/schemas/Attachment",
"description": "The actual form, by reference or inclusion, for printing the content or an EOB."
},
"processNote": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_ProcessNote",
"description": "A note that describes or explains adjudication results in a human readable form."
}
},
"benefitPeriod": {
"$ref": "#/components/schemas/Period",
"description": "The term of the benefits documented in this response."
},
"benefitBalance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_BenefitBalance",
"description": "Balance by Benefit Category."
}
}
},
"required": [
"status",
"type",
"use",
"patient",
"created",
"insurer",
"provider",
"outcome",
"insurance"
]
}
],
"example": {
"resourceType": "ExplanationOfBenefit",
"meta": {
"versionId": "2knRNo5wSQ",
"lastUpdated": "2021-04-12T14:34:37.298-05:00",
"source": "5bNLKC_W1B",
"profile": [
"TUIbgN91zt"
],
"security": [
{
"system": "81Tam_wpN6",
"version": "A3Z2I5Ug1D",
"code": "H2Hfwhog51",
"display": "eAfvrKD_XK",
"userSelected": true
}
],
"tag": [
{
"system": "XFeMbngaTK",
"version": "ARm9v3Nm6p",
"code": "K9nRfkwayx",
"display": "xYAc5a7a_f",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "VqZgskUh2c",
"language": "en-US",
"text": {
"status": "empty",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "MPaCkAkRJR",
"version": "RjDthv77wv",
"code": "3HuTRYTwgB",
"display": "aGZ0LdcQL1",
"userSelected": true
}
],
"text": "ScjCnhTWwv"
},
"system": "HNZddJcYx0",
"value": "UdO3BHiSxt",
"period": {
"start": "2021-04-12T14:34:37.239-05:00",
"end": "2021-04-12T14:34:37.239-05:00"
}
}
],
"status": "cancelled",
"type": {
"coding": [
{
"system": "fRXiTaUd5x",
"version": "jQbpwJRZox",
"code": "G_HTLekDhp",
"display": "EmrQn46Pbq",
"userSelected": true
}
],
"text": "MLy3DwuDTt"
},
"subType": {
"coding": [
{
"system": "84O1LKikP3",
"version": "aYMD1DjmWW",
"code": "gc7wkJHhpQ",
"display": "w_zuFQjfDh",
"userSelected": true
}
],
"text": "TSLoJdxSeb"
},
"use": "claim",
"patient": {
"reference": "Patient/vL22QKbkVv",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "oyBIsfouAe",
"version": "Io5dQ5vcYL",
"code": "ACTvQyv0oO",
"display": "KbvGGppHRl",
"userSelected": true
}
],
"text": "H9YnMoI4yg"
},
"system": "Lt0VI5UL5n",
"value": "Iey6PTQh8Q",
"period": {
"start": "2021-04-12T14:34:37.232-05:00",
"end": "2021-04-12T14:34:37.232-05:00"
}
},
"display": "tQU7Gm9MfA"
},
"billablePeriod": {
"start": "2021-04-12T14:34:37.246-05:00",
"end": "2021-04-12T14:34:37.246-05:00"
},
"created": "2021-04-12T14:34:37.232-05:00",
"enterer": {
"reference": "Practitioner/kBVQ-HMqOi",
"type": "Practitioner",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "ZTZ0cbYQVt",
"version": "fl8JS4ua6S",
"code": "tltnoTIu52",
"display": "fEB3BmBkMz",
"userSelected": true
}
],
"text": "vVS0aTWW5v"
},
"system": "jOTtvGXXti",
"value": "nubBMrkWB1",
"period": {
"start": "2021-04-12T14:34:37.233-05:00",
"end": "2021-04-12T14:34:37.233-05:00"
}
},
"display": "RO8tnqY99C"
},
"insurer": {
"reference": "Organization/837pSsA4Fq",
"type": "Organization",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "UHSmx0f1n0",
"version": "IV4CbJFmkj",
"code": "OYa_yclLny",
"display": "e3NoPc_Y5_",
"userSelected": true
}
],
"text": "k0U5q4F41a"
},
"system": "v1_deQd2DV",
"value": "cOEeN2FiCC",
"period": {
"start": "2021-04-12T14:34:37.247-05:00",
"end": "2021-04-12T14:34:37.247-05:00"
}
},
"display": "F5OrXnCthn"
},
"provider": {
"reference": "Practitioner/STv5bwaCdf",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "_HV6FU0NBn",
"version": "k0Z_R5385Z",
"code": "N1stBJtylw",
"display": "rM15OnASMH",
"userSelected": true
}
],
"text": "GoJTs484gt"
},
"system": "sIsBuYr3dJ",
"value": "InktLZoMoF",
"period": {
"start": "2021-04-12T14:34:37.277-05:00",
"end": "2021-04-12T14:34:37.277-05:00"
}
},
"display": "7axGfmMRjW"
},
"priority": {
"coding": [
{
"system": "INELoNiGeB",
"version": "FBHdVzyusZ",
"code": "iyoxQNFIVM",
"display": "6jzFQfDsXB",
"userSelected": true
}
],
"text": "al3Si1SX8E"
},
"fundsReserveRequested": {
"coding": [
{
"system": "FPrh6m5UD7",
"version": "8Pxe_3f2Jc",
"code": "W2WK2q7JzQ",
"display": "NJk1FKX83o",
"userSelected": true
}
],
"text": "3jlLAu1je4"
},
"fundsReserve": {
"coding": [
{
"system": "IPUdtsy5bY",
"version": "5IyGuseJtm",
"code": "pS5gy3p9jL",
"display": "P0nK18paCv",
"userSelected": true
}
],
"text": "HkFtFuU1yP"
},
"related": [
{
"claim": {
"reference": "Claim/HiUGEV5fk5",
"type": "Claim",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "Os5wcysvZe",
"version": "nDQCTVNTOb",
"code": "jFuvYRPyXC",
"display": "bCczENX6aD",
"userSelected": true
}
],
"text": "XcjEbFwqny"
},
"system": "sk0aRfIAG6",
"value": "Rh44OaL4wm",
"period": {
"start": "2021-04-12T14:34:37.274-05:00",
"end": "2021-04-12T14:34:37.275-05:00"
}
},
"display": "iWPHZWxUkx"
},
"relationship": {
"coding": [
{
"system": "nhbisxUxyd",
"version": "8_YIB0slyb",
"code": "FEEf4L3pEo",
"display": "dEx8yyBT9_",
"userSelected": true
}
],
"text": "eHekp3p0oi"
},
"reference": {
"use": "secondary",
"type": {
"coding": [
{
"system": "ttU0cqhmqB",
"version": "oig1pceMv7",
"code": "TK8WckTu8E",
"display": "APG3GX_cZ8",
"userSelected": true
}
],
"text": "ii4YZiRnsH"
},
"system": "3MtvKf7bqI",
"value": "tJCCGAoVTS",
"period": {
"start": "2021-04-12T14:34:37.274-05:00",
"end": "2021-04-12T14:34:37.274-05:00"
}
}
}
],
"prescription": {
"reference": "MedicationRequest/aSICvDu63r",
"type": "MedicationRequest",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "J7qvy_yjjY",
"version": "hzMcS1Vk5x",
"code": "4zUimNDaFj",
"display": "WigL2BiY6I",
"userSelected": true
}
],
"text": "OjiHaJec9i"
},
"system": "q9KoTFiWdf",
"value": "RMU9lktCHf",
"period": {
"start": "2021-04-12T14:34:37.248-05:00",
"end": "2021-04-12T14:34:37.248-05:00"
}
},
"display": "gMY3KyfVGd"
},
"originalPrescription": {
"reference": "MedicationRequest/9G11TlLDaA",
"type": "MedicationRequest",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "23myiv8tZR",
"version": "SfiebKDbNH",
"code": "Pm4yL3fJIC",
"display": "alcT23n1fR",
"userSelected": true
}
],
"text": "brJ_ThZaIc"
},
"system": "ciCJzL40BH",
"value": "f5cmYAPSJV",
"period": {
"start": "2021-04-12T14:34:37.249-05:00",
"end": "2021-04-12T14:34:37.249-05:00"
}
},
"display": "k0DoMEdp7A"
},
"payee": {
"type": {
"coding": [
{
"system": "C5MkE6vbS_",
"version": "bVoXyKHcPI",
"code": "3lo5JqqzTm",
"display": "tigM8adBAN",
"userSelected": true
}
],
"text": "DRCcVMWNCI"
},
"party": {
"reference": "Practitioner/U059K658qq",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "ZwLscMLhbk",
"version": "pKOdPjhfUD",
"code": "CvpKZKIadA",
"display": "pW0J7dKKym",
"userSelected": true
}
],
"text": "qP5rTrLZfI"
},
"system": "NJ3Rp7o7H6",
"value": "AmEWYXoFkf",
"period": {
"start": "2021-04-12T14:34:37.25-05:00",
"end": "2021-04-12T14:34:37.25-05:00"
}
},
"display": "uNGM63x4uU"
}
},
"referral": {
"reference": "ServiceRequest/aL4SW3WKsX",
"type": "ServiceRequest",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "8UR2xRps_K",
"version": "sLAk7esrzr",
"code": "fIzkPvdCcX",
"display": "Yk_IDhvIsZ",
"userSelected": true
}
],
"text": "tS4mdZbOvk"
},
"system": "WclQW_fLec",
"value": "sbwfioaMOe",
"period": {
"start": "2021-04-12T14:34:37.25-05:00",
"end": "2021-04-12T14:34:37.251-05:00"
}
},
"display": "0HtCQVdPS5"
},
"facility": {
"reference": "Location/30TLQaFD3v",
"type": "Location",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "qp8fStNQZU",
"version": "sh5rPVbx_e",
"code": "tlQ5593r2A",
"display": "e6myeey7ih",
"userSelected": true
}
],
"text": "OuZtCObS8i"
},
"system": "CYplkzCHpH",
"value": "tpA89rm7dc",
"period": {
"start": "2021-04-12T14:34:37.251-05:00",
"end": "2021-04-12T14:34:37.251-05:00"
}
},
"display": "6xMzdnNCay"
},
"claim": {
"reference": "Claim/uuXfBcl6u-",
"type": "Claim",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "qiHYHBWg78",
"version": "pxsU33596W",
"code": "PU6EtJPapm",
"display": "cypvjJs01C",
"userSelected": true
}
],
"text": "Ef2ccdQX_i"
},
"system": "V28EzyMl72",
"value": "gxyW5qzJh0",
"period": {
"start": "2021-04-12T14:34:37.241-05:00",
"end": "2021-04-12T14:34:37.242-05:00"
}
},
"display": "CdTmZXQodQ"
},
"claimResponse": {
"reference": "ClaimResponse/nNS0yITuP6",
"type": "ClaimResponse",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "00Wkty2K47",
"version": "zU4gv_5yfP",
"code": "CYuXtHxZXh",
"display": "GEAZ8XU_5p",
"userSelected": true
}
],
"text": "C4i8kyUHor"
},
"system": "xKqGDbLr3u",
"value": "97R1j27dwz",
"period": {
"start": "2021-04-12T14:34:37.242-05:00",
"end": "2021-04-12T14:34:37.243-05:00"
}
},
"display": "ENI2Y80GBm"
},
"outcome": "error",
"disposition": "VcvQxCSqux",
"preAuthRef": [
"FSb2ql3diW"
],
"preAuthRefPeriod": [
{
"start": "2021-04-12T14:34:37.236-05:00",
"end": "2021-04-12T14:34:37.236-05:00"
}
],
"careTeam": [
{
"sequence": 1679414253,
"provider": {
"reference": "Practitioner/QJWsZjVqca",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "kmIIBCvnwt",
"version": "DmqCW7329x",
"code": "PYjD0BXv3N",
"display": "IjgoojH_Ia",
"userSelected": true
}
],
"text": "UxdUezOIpk"
},
"system": "8O18ziqTdL",
"value": "duMJz3rS2e",
"period": {
"start": "2021-04-12T14:34:37.24-05:00",
"end": "2021-04-12T14:34:37.241-05:00"
}
},
"display": "MXFiq97urR"
},
"responsible": true,
"role": {
"coding": [
{
"system": "iMB5EwHuBf",
"version": "TBb6qvLCyW",
"code": "J4ZYzfvF7_",
"display": "NRIYJNbHOy",
"userSelected": true
}
],
"text": "YcKIWzFmHX"
},
"qualification": {
"coding": [
{
"system": "XhKj_LwJgK",
"version": "F4tqyGyLgY",
"code": "lvBKHehAmV",
"display": "ZC2mQ3zNpk",
"userSelected": true
}
],
"text": "dV9eSSWIZU"
}
}
],
"supportingInfo": [
{
"sequence": 822233605,
"category": {
"coding": [
{
"system": "scSr08nRf2",
"version": "4UERc8Lwws",
"code": "vhJPNJD0q9",
"display": "PlsWJrBztL",
"userSelected": true
}
],
"text": "JgNma3mp7w"
},
"code": {
"coding": [
{
"system": "6q3JVBUN1z",
"version": "2Hi5Rnu6Mr",
"code": "bWf5fCgaTM",
"display": "vOWYQEx_wR",
"userSelected": true
}
],
"text": "rkvcNqjq8T"
},
"timingDate": "2021-04-12",
"valueBoolean": true,
"reason": {
"system": "4x5UlIQeN1",
"version": "K7p0RQ0EYa",
"code": "SQrF52M10R",
"display": "FH20UtqlJE",
"userSelected": true
}
}
],
"diagnosis": [
{
"sequence": 243119524,
"diagnosisCodeableConcept": {
"coding": [
{
"system": "QArmQhsokK",
"version": "qy0RdmhRyd",
"code": "lwLuwECEBp",
"display": "LiDOQxXZGe",
"userSelected": true
}
],
"text": "OZT1JDea3t"
},
"type": [
{
"coding": [
{
"system": "P7B25ufGfL",
"version": "08VEe6oQ9z",
"code": "ShoWpROaW_",
"display": "bXtC8aYJGc",
"userSelected": true
}
],
"text": "DcEH3IF6gs"
}
],
"onAdmission": {
"coding": [
{
"system": "4nKibBC0rr",
"version": "C9gm0qWhNE",
"code": "Jv412ky4rE",
"display": "xTSW0thEzd",
"userSelected": true
}
],
"text": "RkWr9m0ZWe"
},
"packageCode": {
"coding": [
{
"system": "RTTu73cgBD",
"version": "2DFylII2D8",
"code": "aeEXikgpby",
"display": "xVWqKJhB73",
"userSelected": true
}
],
"text": "DE7fMnxCDY"
}
}
],
"procedure": [
{
"sequence": 722070560,
"type": [
{
"coding": [
{
"system": "Hq6WIOGBTt",
"version": "3lmoOybBWd",
"code": "Jb6zfq5qOz",
"display": "SAOuB7RUWb",
"userSelected": true
}
],
"text": "dcvKKinLNa"
}
],
"date": "2021-04-12T14:34:37.246-05:00",
"procedureCodeableConcept": {
"coding": [
{
"system": "9vZX_ha8zu",
"version": "6HmCYnh0ea",
"code": "uynqKmH18C",
"display": "fRTrWefCua",
"userSelected": true
}
],
"text": "d7UVwkEkDs"
},
"udi": [
{
"reference": "Device/pqA36t1G2X",
"type": "Device",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "Dk_XGPx_F_",
"version": "T06U1N2fOD",
"code": "86ZqR8OhRg",
"display": "Xd3WOBrZPw",
"userSelected": true
}
],
"text": "lUrOp7_veZ"
},
"system": "wt0JEft1wF",
"value": "c9cgUCwYeo",
"period": {
"start": "2021-04-12T14:34:37.244-05:00",
"end": "2021-04-12T14:34:37.244-05:00"
}
},
"display": "dmD9yiFW68"
}
]
}
],
"precedence": 1138358243,
"insurance": [
{
"focal": true,
"coverage": {
"reference": "Coverage/4UF7GVbO00",
"type": "Coverage",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "R2JlkVjZJp",
"version": "OGdfQbT5BR",
"code": "9PZTOwHn_N",
"display": "_1uiXV8HGz",
"userSelected": true
}
],
"text": "yPDqfJeyTE"
},
"system": "48vkuFj84v",
"value": "HYAmZzPKHP",
"period": {
"start": "2021-04-12T14:34:37.253-05:00",
"end": "2021-04-12T14:34:37.253-05:00"
}
},
"display": "cIiq6P8DWj"
},
"preAuthRef": [
"FcwnipImj_"
]
}
],
"accident": {
"date": "2021-04-12",
"type": {
"coding": [
{
"system": "sTmKHsKVQu",
"version": "lW6G58JwDQ",
"code": "pjYdp1gmJR",
"display": "1mGssuUWaw",
"userSelected": true
}
],
"text": "GkKwwwD_fm"
},
"locationAddress": {
"use": "billing",
"type": "postal",
"text": "wfLfOLDwAk",
"line": [
"3ukUCbyrbJ"
],
"city": "iiW4ZxdjyR",
"district": "BXs5awgq7x",
"state": "7Va8ltkeHQ",
"postalCode": "cjekPLjdKS",
"country": "e9psqOEJcz",
"period": {
"start": "2021-04-12T14:34:37.255-05:00",
"end": "2021-04-12T14:34:37.255-05:00"
}
}
},
"item": [
{
"sequence": 1965511457,
"careTeamSequence": [
288064480
],
"diagnosisSequence": [
363205100
],
"procedureSequence": [
453718962
],
"informationSequence": [
1334842145
],
"revenue": {
"coding": [
{
"system": "AqBB0VDMgk",
"version": "g_4Sx1y0rG",
"code": "3tbKpU0aKk",
"display": "Vdbro1wdSL",
"userSelected": true
}
],
"text": "OW3DRFgEAs"
},
"category": {
"coding": [
{
"system": "nW4VObMrxI",
"version": "5FiVQTCp5s",
"code": "nJk_8ESksa",
"display": "oqE0foH52d",
"userSelected": true
}
],
"text": "7vUe1od8je"
},
"productOrService": {
"coding": [
{
"system": "CZgtPDExo_",
"version": "FG6kO51JQ8",
"code": "M1Zg3PO93D",
"display": "lp5NdEZbxQ",
"userSelected": true
}
],
"text": "eaHQ9vNXZG"
},
"modifier": [
{
"coding": [
{
"system": "xXwCm9zNLW",
"version": "FPYuXGNtkV",
"code": "uuYzzPIl01",
"display": "vAtN6gGWEq",
"userSelected": true
}
],
"text": "CH5ffl3Tze"
}
],
"programCode": [
{
"coding": [
{
"system": "keB2i4cdTZ",
"version": "mONTnSNGU1",
"code": "iShtn_mtKL",
"display": "uRpgLrRRs7",
"userSelected": true
}
],
"text": "tHtGB6gZpE"
}
],
"servicedDate": "2021-04-12",
"locationCodeableConcept": {
"coding": [
{
"system": "QHkwyOpxVQ",
"version": "4NiyZY0dNT",
"code": "1m5tz7PVAH",
"display": "POAl58pYNR",
"userSelected": true
}
],
"text": "lDS8wFYbjz"
},
"quantity": {
"value": 464518073443,
"unit": "XdexMkBXeX",
"system": "kcGKvHekgR",
"code": "t9NFemwcdy"
},
"unitPrice": {
"value": 207909236562,
"currency": "iumixtvQDR"
},
"factor": 233007505004,
"net": {
"value": 534707590242,
"currency": "HWqcL5bGOj"
},
"udi": [
{
"reference": "Device/lvXTY4-EOq",
"type": "Device",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "8rp0WHh1rE",
"version": "e9DvzBkUTG",
"code": "fX5vUhiGfp",
"display": "lwNv773IBK",
"userSelected": true
}
],
"text": "xYG79nER6l"
},
"system": "E94Y56ebAY",
"value": "fawv1NmpKE",
"period": {
"start": "2021-04-12T14:34:37.281-05:00",
"end": "2021-04-12T14:34:37.281-05:00"
}
},
"display": "n71B1RZiDW"
}
],
"bodySite": {
"coding": [
{
"system": "UyyQxJnUMp",
"version": "qlgGVilsGt",
"code": "5PHCYbKBxf",
"display": "ewThd6lRym",
"userSelected": true
}
],
"text": "KC07tFzudE"
},
"subSite": [
{
"coding": [
{
"system": "HdmVXudLKQ",
"version": "l01hpmhRp0",
"code": "K2o4n1RQoW",
"display": "8uECMRCMIY",
"userSelected": true
}
],
"text": "vMABbnJCXp"
}
],
"encounter": [
{
"reference": "Encounter/4ysif00UDZ",
"type": "Encounter",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "ax6P9RLZlj",
"version": "4nai_j_aL2",
"code": "AmGefNl00_",
"display": "J2Ls1ICM76",
"userSelected": true
}
],
"text": "tuVqkAzMyJ"
},
"system": "sC00bhz4A3",
"value": "7cwQVLDBjj",
"period": {
"start": "2021-04-12T14:34:37.295-05:00",
"end": "2021-04-12T14:34:37.295-05:00"
}
},
"display": "E2UnYSI4hn"
}
],
"noteNumber": [
488486656
],
"adjudication": [
{
"category": {
"coding": [
{
"system": "a5d558axdx",
"version": "GFjtYYPB77",
"code": "VFXYaEngHa",
"display": "z3KaTNEGu0",
"userSelected": true
}
],
"text": "RAKj1l_WP4"
},
"reason": {
"coding": [
{
"system": "DC4QBeyz0j",
"version": "iC1VYktzcY",
"code": "QiYxcIorms",
"display": "v5TgftMPb9",
"userSelected": true
}
],
"text": "_LVewQXcba"
},
"amount": {
"value": 284261369139,
"currency": "3RrZvaD_OM"
},
"value": 137847405145
}
],
"detail": [
{
"sequence": 714520598,
"revenue": {
"coding": [
{
"system": "PzewfuLPtD",
"version": "xeQVddbH95",
"code": "lE0HgE2NUA",
"display": "uYW4dl4VX1",
"userSelected": true
}
],
"text": "Q0gvC0hZYX"
},
"category": {
"coding": [
{
"system": "GlYru50JqC",
"version": "eEMIhEBEAt",
"code": "8qZqsJ2IhS",
"display": "ghbKWSVQYW",
"userSelected": true
}
],
"text": "gKcrRxfr7F"
},
"productOrService": {
"coding": [
{
"system": "_M3eUMgbCF",
"version": "SRtguTjWcD",
"code": "hOAMs70nND",
"display": "fqX0xkwg9a",
"userSelected": true
}
],
"text": "eSzVx2RTA5"
},
"modifier": [
{
"coding": [
{
"system": "GLp_9AiNUz",
"version": "6RyjwfE39a",
"code": "HuQayv3AHR",
"display": "GJYmcj7Ej1",
"userSelected": true
}
],
"text": "BU72Z_Gpp0"
}
],
"programCode": [
{
"coding": [
{
"system": "Obi_zph7v2",
"version": "04oc90glS5",
"code": "3cQNJpSCCB",
"display": "gFYh69nwsf",
"userSelected": true
}
],
"text": "Q6Pv7i9Qr9"
}
],
"quantity": {
"value": 465300975389,
"unit": "EteBgWwgzV",
"system": "l9bbfsAfyw",
"code": "skcgGS8OnC"
},
"unitPrice": {
"value": 498305861128,
"currency": "7a54xY9eMy"
},
"factor": 5018579322,
"net": {
"value": 86392272950,
"currency": "x19YJ78AFS"
},
"udi": [
{
"reference": "Device/ZRPrpcFOnL",
"type": "Device",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "EdB4gjiHj0",
"version": "CZW51j5Kkc",
"code": "_iz5P8Wzo2",
"display": "um065uJHUE",
"userSelected": true
}
],
"text": "YVdu2vnNSQ"
},
"system": "bOwcDGsIzS",
"value": "FxECH17zv2",
"period": {
"start": "2021-04-12T14:34:37.284-05:00",
"end": "2021-04-12T14:34:37.284-05:00"
}
},
"display": "lvHruJcZ6Y"
}
],
"noteNumber": [
705625239
],
"adjudication": [
{
"category": {
"coding": [
{
"system": "p6329HcXJJ",
"version": "0OO2dy61VJ",
"code": "zdTCHQW5so",
"display": "tUXNQUD5JW",
"userSelected": true
}
],
"text": "urbkrbLqTB"
},
"reason": {
"coding": [
{
"system": "WjO3JKT1i0",
"version": "xymn0qllRw",
"code": "79Zo4N2sf1",
"display": "H8x4S2sGnQ",
"userSelected": true
}
],
"text": "5G86kGLdvE"
},
"amount": {
"value": 95515579191,
"currency": "gqrE3ioEbl"
},
"value": 143464416512
}
],
"subDetail": [
{
"sequence": 657685715,
"revenue": {
"coding": [
{
"system": "_hm1AzM4Fj",
"version": "gsOIXzUCLP",
"code": "qmcu8BssZD",
"display": "eZEle5yHcl",
"userSelected": true
}
],
"text": "4KYezsUsXM"
},
"category": {
"coding": [
{
"system": "g3mN0GFbC0",
"version": "vIuBqA2Jda",
"code": "ZtxZMkvasV",
"display": "4u17LcFujg",
"userSelected": true
}
],
"text": "l9qlGo6Yt7"
},
"productOrService": {
"coding": [
{
"system": "DxaO0ZNP71",
"version": "yczKiWy54y",
"code": "LyKCFhOCs5",
"display": "lS4VCLTsSW",
"userSelected": true
}
],
"text": "FTeLWUMcax"
},
"modifier": [
{
"coding": [
{
"system": "BmkovQ4g5E",
"version": "Q3JVYC17e9",
"code": "T441BG5QXN",
"display": "rSuLNKs80T",
"userSelected": true
}
],
"text": "9P7uNu3uRj"
}
],
"programCode": [
{
"coding": [
{
"system": "5f5PHPsYts",
"version": "bBdBfXodUp",
"code": "gGgtRpdNjr",
"display": "Eeu9d1ROis",
"userSelected": true
}
],
"text": "L0RkQS1yRm"
}
],
"quantity": {
"value": 302076397359,
"unit": "MgoyboJIPf",
"system": "Q_UJg_kMky",
"code": "l0hy9BR7h9"
},
"unitPrice": {
"value": 228071117906,
"currency": "4Wh3tEAYsi"
},
"factor": 34870928251,
"net": {
"value": 194800469852,
"currency": "pPMEa_XEs4"
},
"udi": [
{
"reference": "Device/PGltxwOrk4",
"type": "Device",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "pQMWshbz3_",
"version": "u1WgmC9CnG",
"code": "ykj9hT2_fX",
"display": "ry11kFxTeh",
"userSelected": true
}
],
"text": "ZRGiOy6QaC"
},
"system": "7sa1lbBWMV",
"value": "34UDOmppjF",
"period": {
"start": "2021-04-12T14:34:37.287-05:00",
"end": "2021-04-12T14:34:37.287-05:00"
}
},
"display": "X_DriB91zo"
}
],
"noteNumber": [
105517095
],
"adjudication": [
{
"category": {
"coding": [
{
"system": "X9Bh46pwFN",
"version": "qGRu2ml9bl",
"code": "M4cnuoBbvT",
"display": "XSQWkh_El6",
"userSelected": true
}
],
"text": "sG8p7MgRra"
},
"reason": {
"coding": [
{
"system": "avfiBXGSXK",
"version": "zXrCPrVfNz",
"code": "xli3JPSg_h",
"display": "LPUa7PCI1K",
"userSelected": true
}
],
"text": "o0CVardRTy"
},
"amount": {
"value": 91659703652,
"currency": "mU4YPTVJvl"
},
"value": 495620808254
}
]
}
]
}
]
}
],
"addItem": [
{
"itemSequence": [
1605808621
],
"detailSequence": [
1765844199
],
"subDetailSequence": [
864114365
],
"provider": [
{
"reference": "Practitioner/CnJfDRykEw",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "6UfkVEXgmb",
"version": "t8iOfJnCY1",
"code": "3k_3LT8WMp",
"display": "Gz6TmqcUeg",
"userSelected": true
}
],
"text": "Go7lxyWwQW"
},
"system": "If7IQQ0ADZ",
"value": "FqzkSOy3RU",
"period": {
"start": "2021-04-12T14:34:37.272-05:00",
"end": "2021-04-12T14:34:37.272-05:00"
}
},
"display": "rWCVaiy0EA"
}
],
"productOrService": {
"coding": [
{
"system": "ZvHIPm9oNR",
"version": "H_XaPvF7Mu",
"code": "vK3EegDiZn",
"display": "aVPFtDygPb",
"userSelected": true
}
],
"text": "9_v2jfWLr7"
},
"modifier": [
{
"coding": [
{
"system": "qSJtQvagUZ",
"version": "umklGXkGd2",
"code": "aTyPG38VEA",
"display": "Q3PPzQFGYz",
"userSelected": true
}
],
"text": "vUPSlmqDqo"
}
],
"programCode": [
{
"coding": [
{
"system": "Dd7RwIOnMt",
"version": "mjMbhCtuZI",
"code": "8aC5veSMIS",
"display": "xxTkBu5Pyf",
"userSelected": true
}
],
"text": "XEQz0rGLJU"
}
],
"servicedDate": "2021-04-12",
"locationCodeableConcept": {
"coding": [
{
"system": "jDvS0RI_MJ",
"version": "uH_vkykQny",
"code": "HWDK5GDr8l",
"display": "BWeqOXf64G",
"userSelected": true
}
],
"text": "6OcGvS0yz9"
},
"quantity": {
"value": 323214078312,
"unit": "7_eznhkUHb",
"system": "2HRdocOjqt",
"code": "kQnLGoi0eo"
},
"unitPrice": {
"value": 357558201898,
"currency": "ERvlvxIzz2"
},
"factor": 443765640498,
"net": {
"value": 529814406727,
"currency": "4g_Ka42Tgh"
},
"bodySite": {
"coding": [
{
"system": "Vgd3v6AjVc",
"version": "jhjamhlb_S",
"code": "iCyFTtBDlR",
"display": "z4aotcL5a2",
"userSelected": true
}
],
"text": "xiVrxkBzks"
},
"subSite": [
{
"coding": [
{
"system": "3MSbwFijAP",
"version": "qhzaCGWoeE",
"code": "PhjE8xTPy3",
"display": "ebnZRndT2M",
"userSelected": true
}
],
"text": "G7O4IFhori"
}
],
"noteNumber": [
1846372736
],
"adjudication": [
{
"category": {
"coding": [
{
"system": "xx1yqc_Dga",
"version": "MtNiWiHHnX",
"code": "cXtlfoUykL",
"display": "yGng787Onr",
"userSelected": true
}
],
"text": "ifCJa9DymK"
},
"reason": {
"coding": [
{
"system": "Nuf9bqZKt_",
"version": "aJ4oyYTxa_",
"code": "T96lYwfCyA",
"display": "voZUze1Hhx",
"userSelected": true
}
],
"text": "W7LBLFHzMx"
},
"amount": {
"value": 529507438600,
"currency": "gxWSiuUykJ"
},
"value": 288250920985
}
],
"detail": [
{
"productOrService": {
"coding": [
{
"system": "zJUoW02xDI",
"version": "_e060lFwsT",
"code": "sO8SIVViDQ",
"display": "QjlDMmmgsj",
"userSelected": true
}
],
"text": "ZTKg8NmAxF"
},
"modifier": [
{
"coding": [
{
"system": "o92H45V1F4",
"version": "5vOajW1DMV",
"code": "Z4TOaNFA0I",
"display": "Hyw55pssXm",
"userSelected": true
}
],
"text": "2HitdCmLEE"
}
],
"quantity": {
"value": 425526059642,
"unit": "XFmMsuU_p5",
"system": "GFcD9cz2Fe",
"code": "SfKeZqvaHb"
},
"unitPrice": {
"value": 10541491582,
"currency": "eAOFcxWkML"
},
"factor": 499595094275,
"net": {
"value": 56814276103,
"currency": "5a79RB4kJC"
},
"noteNumber": [
1984300870
],
"adjudication": [
{
"category": {
"coding": [
{
"system": "qzowSYyLRk",
"version": "EwUzKLy9N6",
"code": "KRTR7wprt3",
"display": "V9bK2NJov6",
"userSelected": true
}
],
"text": "K6vedWHnc0"
},
"reason": {
"coding": [
{
"system": "2MrIJpAvFO",
"version": "NOt3wKzr29",
"code": "Shxnb6_8Kq",
"display": "JNC38uiY2i",
"userSelected": true
}
],
"text": "9aZxy8rZYH"
},
"amount": {
"value": 133233313114,
"currency": "xPZYXBFI3F"
},
"value": 313974742538
}
],
"subDetail": [
{
"productOrService": {
"coding": [
{
"system": "Os2z6vtaOh",
"version": "zFSUARxEpk",
"code": "UPhrBt1Om9",
"display": "qvIjAt0a39",
"userSelected": true
}
],
"text": "ZSorTUK4tE"
},
"modifier": [
{
"coding": [
{
"system": "6ui8Ldku1W",
"version": "1P55nWAY0M",
"code": "4D72l9_ShW",
"display": "xGa3xQ5SrN",
"userSelected": true
}
],
"text": "u0RXG4gJPZ"
}
],
"quantity": {
"value": 323403448430,
"unit": "SfTHCka5Aq",
"system": "G3AHydUIi2",
"code": "UhX5A0DtwD"
},
"unitPrice": {
"value": 453075995653,
"currency": "ReUN4wja8A"
},
"factor": 546256918325,
"net": {
"value": 121439344957,
"currency": "YUPXGGt2Xc"
},
"noteNumber": [
1126720472
],
"adjudication": [
{
"category": {
"coding": [
{
"system": "tILkS467y5",
"version": "kczmlhSfi0",
"code": "pUHU5XosO9",
"display": "KCr2PE2g2r",
"userSelected": true
}
],
"text": "6jWnbqmucA"
},
"reason": {
"coding": [
{
"system": "kMe8xzzvea",
"version": "EuXDcb5ek4",
"code": "52OJbfo0CV",
"display": "ID53CHFXPR",
"userSelected": true
}
],
"text": "6ZMmZ3PhTv"
},
"amount": {
"value": 158965197908,
"currency": "QVIjwmQyVN"
},
"value": 474214188901
}
]
}
]
}
]
}
],
"adjudication": [
{
"category": {
"coding": [
{
"system": "flK8RjIThP",
"version": "KMbnC35mCO",
"code": "wKbQHSsXda",
"display": "mDB8CkwiBg",
"userSelected": true
}
],
"text": "Cx0tv3fQPp"
},
"reason": {
"coding": [
{
"system": "3d4sAAz2hy",
"version": "s1GSdV3AU0",
"code": "USFLrVLEFP",
"display": "6hKpRf6y0p",
"userSelected": true
}
],
"text": "_TM9Y1cLic"
},
"amount": {
"value": 507936315970,
"currency": "K4QQIRcMyc"
},
"value": 373752876824
}
],
"total": [
{
"category": {
"coding": [
{
"system": "gDIogsmFZx",
"version": "3fJp9W2Pcj",
"code": "QsSQpKUT8G",
"display": "1J3binHzcw",
"userSelected": true
}
],
"text": "00K_JciseM"
},
"amount": {
"value": 541403405656,
"currency": "vJI262RA13"
}
}
],
"payment": {
"type": {
"coding": [
{
"system": "dkGzaCzh0w",
"version": "eJaZDzT2ia",
"code": "Kxe6urLLN5",
"display": "Ccf3V4uIq3",
"userSelected": true
}
],
"text": "wIo6QP04ml"
},
"adjustment": {
"value": 133883505777,
"currency": "ynVb1KJAky"
},
"adjustmentReason": {
"coding": [
{
"system": "OtJFwWPz1g",
"version": "i76dw2Y4Zg",
"code": "Z6r7PSxaoU",
"display": "9zqQ2MxcD8",
"userSelected": true
}
],
"text": "_DHSMsDRtE"
},
"date": "2021-04-12",
"amount": {
"value": 39011959421,
"currency": "FAFNHYeWAC"
},
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "_tp6FmUHRQ",
"version": "S2JUOPow4B",
"code": "ItgT6W_S9u",
"display": "CttOuhGFC4",
"userSelected": true
}
],
"text": "r6PcGWbyMx"
},
"system": "WAnb0Mny3P",
"value": "OVyTDEPC7O",
"period": {
"start": "2021-04-12T14:34:37.256-05:00",
"end": "2021-04-12T14:34:37.256-05:00"
}
}
},
"formCode": {
"coding": [
{
"system": "8dCVKmdBbO",
"version": "_6sG7LTuxR",
"code": "vcslHeJeTi",
"display": "gSdnLZLiHX",
"userSelected": true
}
],
"text": "UhbkpEw55J"
},
"form": {
"contentType": "Vp5yzOZGWt",
"language": "en-US",
"data": "enxrBwc=",
"url": "riVKuBHaZg",
"size": 224303416,
"hash": "X003Xyk=",
"title": "YHIzlPWIGu",
"creation": "2021-04-12T14:34:37.276-05:00"
},
"processNote": [
{
"number": 1210879636,
"type": "display",
"text": "QYb8UWJd2U",
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en-US"
}
]
}
}
],
"benefitPeriod": {
"start": "2021-04-12T14:34:37.235-05:00",
"end": "2021-04-12T14:34:37.235-05:00"
},
"benefitBalance": [
{
"category": {
"coding": [
{
"system": "Ts_0yYeios",
"version": "3GDRk_vq4U",
"code": "U7ArxexiZN",
"display": "z6PQIeWeQb",
"userSelected": true
}
],
"text": "TgOqjpDULu"
},
"excluded": true,
"name": "A00RTE3a3r",
"description": "FlHWzL5RKb",
"network": {
"coding": [
{
"system": "saPPbIVPxj",
"version": "0LNJ7I_dwQ",
"code": "9R4XA0JxUj",
"display": "1FRuAevUai",
"userSelected": true
}
],
"text": "HnS7_BjsG0"
},
"unit": {
"coding": [
{
"system": "LzvrlE8Y0m",
"version": "R_7lhyXHuq",
"code": "x7xvkjTQop",
"display": "Ms0z2_XFRj",
"userSelected": true
}
],
"text": "HTMdmdPYmE"
},
"term": {
"coding": [
{
"system": "opDtpCjsE5",
"version": "Jf2XXnaZbH",
"code": "jb9AXGD_T3",
"display": "WBDa663Zoj",
"userSelected": true
}
],
"text": "4h2F2eACUE"
},
"financial": [
{
"type": {
"coding": [
{
"system": "p_CN89rAtv",
"version": "QIpNtZOdl2",
"code": "5V4k66xDQG",
"display": "foNHKG9UGG",
"userSelected": true
}
],
"text": "aXVJ9HswQI"
},
"allowedUnsignedInt": 1432086273,
"usedUnsignedInt": 1020194097
}
]
}
]
}
},
"ExplanationOfBenefit_Accident": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Date of an accident event related to the products and services contained in the claim."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers."
},
"locationAddress": {
"$ref": "#/components/schemas/Address",
"description": "The physical location of the accident event."
},
"locationReference": {
"$ref": "#/components/schemas/Reference",
"description": "The physical location of the accident event."
}
}
}
]
},
"ExplanationOfBenefit_AddItem": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"itemSequence": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "Claim items which this service line is intended to replace."
}
},
"detailSequence": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The sequence number of the details within the claim item which this line is intended to replace."
}
},
"subDetailSequence": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The sequence number of the sub–details woithin the details within the claim item which this line is intended to replace."
}
},
"provider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The providers who are authorized for the services rendered to the patient."
}
},
"productOrService": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item."
},
"modifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Item typification or modifiers codes to convey additional context for the product or service."
}
},
"programCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the program under which this may be recovered."
}
},
"servicedDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The date or dates when the service or product was supplied, performed or completed."
},
"servicedPeriod": {
"$ref": "#/components/schemas/Period",
"description": "The date or dates when the service or product was supplied, performed or completed."
},
"locationCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Where the product or service was provided."
},
"locationAddress": {
"$ref": "#/components/schemas/Address",
"description": "Where the product or service was provided."
},
"locationReference": {
"$ref": "#/components/schemas/Reference",
"description": "Where the product or service was provided."
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The number of repetitions of a service or product."
},
"unitPrice": {
"$ref": "#/components/schemas/Money",
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group."
},
"factor": {
"type": "number",
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount."
},
"net": {
"$ref": "#/components/schemas/Money",
"description": "The quantity times the unit price for an additional service or product or charge."
},
"bodySite": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Physical service site on the patient (limb, tooth, etc.)."
},
"subSite": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s)."
}
},
"noteNumber": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The numbers associated with notes below which apply to the adjudication of this item."
}
},
"adjudication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Adjudication",
"description": "The adjudication results."
}
},
"detail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_AddItem_Detail",
"description": "The second–tier service adjudications for payor added services."
}
}
},
"required": [
"productOrService"
]
}
]
},
"ExplanationOfBenefit_AddItem_Detail": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"productOrService": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item."
},
"modifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Item typification or modifiers codes to convey additional context for the product or service."
}
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The number of repetitions of a service or product."
},
"unitPrice": {
"$ref": "#/components/schemas/Money",
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group."
},
"factor": {
"type": "number",
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount."
},
"net": {
"$ref": "#/components/schemas/Money",
"description": "The quantity times the unit price for an additional service or product or charge."
},
"noteNumber": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The numbers associated with notes below which apply to the adjudication of this item."
}
},
"adjudication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Adjudication",
"description": "The adjudication results."
}
},
"subDetail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_AddItem_Detail_SubDetail",
"description": "Third–tier of goods and services."
}
}
},
"required": [
"productOrService"
]
}
]
},
"ExplanationOfBenefit_AddItem_Detail_SubDetail": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"productOrService": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item."
},
"modifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Item typification or modifiers codes to convey additional context for the product or service."
}
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The number of repetitions of a service or product."
},
"unitPrice": {
"$ref": "#/components/schemas/Money",
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group."
},
"factor": {
"type": "number",
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount."
},
"net": {
"$ref": "#/components/schemas/Money",
"description": "The quantity times the unit price for an additional service or product or charge."
},
"noteNumber": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The numbers associated with notes below which apply to the adjudication of this item."
}
},
"adjudication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Adjudication",
"description": "The adjudication results."
}
}
},
"required": [
"productOrService"
]
}
]
},
"ExplanationOfBenefit_BenefitBalance": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Code to identify the general type of benefits under which products and services are provided."
},
"excluded": {
"type": "boolean",
"description": "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A short name or tag for the benefit."
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A richer description of the benefit or services covered."
},
"network": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Is a flag to indicate whether the benefits refer to in–network providers or out–of–network providers."
},
"unit": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates if the benefits apply to an individual or to the family."
},
"term": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'."
},
"financial": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_BenefitBalance_Financial",
"description": "Benefits Used to date."
}
}
},
"required": [
"category"
]
}
]
},
"ExplanationOfBenefit_BenefitBalance_Financial": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Classification of benefit being provided."
},
"allowedUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "The quantity of the benefit which is permitted under the coverage."
},
"allowedString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The quantity of the benefit which is permitted under the coverage."
},
"allowedMoney": {
"$ref": "#/components/schemas/Money",
"description": "The quantity of the benefit which is permitted under the coverage."
},
"usedUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "The quantity of the benefit which have been consumed to date."
},
"usedMoney": {
"$ref": "#/components/schemas/Money",
"description": "The quantity of the benefit which have been consumed to date."
}
},
"required": [
"type"
]
}
]
},
"ExplanationOfBenefit_CareTeam": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "A number to uniquely identify care team entries."
},
"provider": {
"$ref": "#/components/schemas/Reference",
"description": "Member of the team who provided the product or service."
},
"responsible": {
"type": "boolean",
"description": "The party who is billing and/or responsible for the claimed products or services."
},
"role": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team."
},
"qualification": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The qualification of the practitioner which is applicable for this service."
}
},
"required": [
"sequence",
"provider"
]
}
]
},
"ExplanationOfBenefit_Diagnosis": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "A number to uniquely identify diagnosis entries."
},
"diagnosisCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition."
},
"diagnosisReference": {
"$ref": "#/components/schemas/Reference",
"description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition."
},
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the condition was observed or the relative ranking."
}
},
"onAdmission": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indication of whether the diagnosis was present on admission to a facility."
},
"packageCode": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system."
}
},
"required": [
"sequence"
]
}
]
},
"ExplanationOfBenefit_Insurance": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"focal": {
"type": "boolean",
"description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true."
},
"coverage": {
"$ref": "#/components/schemas/Reference",
"description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system."
},
"preAuthRef": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization."
}
}
},
"required": [
"focal",
"coverage"
]
}
]
},
"ExplanationOfBenefit_Item": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "A number to uniquely identify item entries."
},
"careTeamSequence": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "Care team members related to this service or product."
}
},
"diagnosisSequence": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "Diagnoses applicable for this service or product."
}
},
"procedureSequence": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "Procedures applicable for this service or product."
}
},
"informationSequence": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "Exceptions, special conditions and supporting information applicable for this service or product."
}
},
"revenue": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type of revenue or cost center providing the product and/or service."
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Code to identify the general type of benefits under which products and services are provided."
},
"productOrService": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item."
},
"modifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Item typification or modifiers codes to convey additional context for the product or service."
}
},
"programCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the program under which this may be recovered."
}
},
"servicedDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The date or dates when the service or product was supplied, performed or completed."
},
"servicedPeriod": {
"$ref": "#/components/schemas/Period",
"description": "The date or dates when the service or product was supplied, performed or completed."
},
"locationCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Where the product or service was provided."
},
"locationAddress": {
"$ref": "#/components/schemas/Address",
"description": "Where the product or service was provided."
},
"locationReference": {
"$ref": "#/components/schemas/Reference",
"description": "Where the product or service was provided."
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The number of repetitions of a service or product."
},
"unitPrice": {
"$ref": "#/components/schemas/Money",
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group."
},
"factor": {
"type": "number",
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount."
},
"net": {
"$ref": "#/components/schemas/Money",
"description": "The quantity times the unit price for an additional service or product or charge."
},
"udi": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Unique Device Identifiers associated with this line item."
}
},
"bodySite": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Physical service site on the patient (limb, tooth, etc.)."
},
"subSite": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s)."
}
},
"encounter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A billed item may include goods or services provided in multiple encounters."
}
},
"noteNumber": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The numbers associated with notes below which apply to the adjudication of this item."
}
},
"adjudication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Adjudication",
"description": "If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item."
}
},
"detail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Detail",
"description": "Second–tier of goods and services."
}
}
},
"required": [
"sequence",
"productOrService"
]
}
]
},
"ExplanationOfBenefit_Item_Adjudication": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in–aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item."
},
"reason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount."
},
"amount": {
"$ref": "#/components/schemas/Money",
"description": "Monetary amount associated with the category."
},
"value": {
"type": "number",
"description": "A non–monetary value associated with the category. Mutually exclusive to the amount element above."
}
},
"required": [
"category"
]
}
]
},
"ExplanationOfBenefit_Item_Detail": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "A claim detail line. Either a simple (a product or service) or a 'group' of sub–details which are simple items."
},
"revenue": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type of revenue or cost center providing the product and/or service."
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Code to identify the general type of benefits under which products and services are provided."
},
"productOrService": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item."
},
"modifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Item typification or modifiers codes to convey additional context for the product or service."
}
},
"programCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the program under which this may be recovered."
}
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The number of repetitions of a service or product."
},
"unitPrice": {
"$ref": "#/components/schemas/Money",
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group."
},
"factor": {
"type": "number",
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount."
},
"net": {
"$ref": "#/components/schemas/Money",
"description": "The quantity times the unit price for an additional service or product or charge."
},
"udi": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Unique Device Identifiers associated with this line item."
}
},
"noteNumber": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The numbers associated with notes below which apply to the adjudication of this item."
}
},
"adjudication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Adjudication",
"description": "The adjudication results."
}
},
"subDetail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Detail_SubDetail",
"description": "Third–tier of goods and services."
}
}
},
"required": [
"sequence",
"productOrService"
]
}
]
},
"ExplanationOfBenefit_Item_Detail_SubDetail": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "A claim detail line. Either a simple (a product or service) or a 'group' of sub–details which are simple items."
},
"revenue": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The type of revenue or cost center providing the product and/or service."
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Code to identify the general type of benefits under which products and services are provided."
},
"productOrService": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item."
},
"modifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Item typification or modifiers codes to convey additional context for the product or service."
}
},
"programCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the program under which this may be recovered."
}
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The number of repetitions of a service or product."
},
"unitPrice": {
"$ref": "#/components/schemas/Money",
"description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group."
},
"factor": {
"type": "number",
"description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount."
},
"net": {
"$ref": "#/components/schemas/Money",
"description": "The quantity times the unit price for an additional service or product or charge."
},
"udi": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Unique Device Identifiers associated with this line item."
}
},
"noteNumber": {
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"description": "The numbers associated with notes below which apply to the adjudication of this item."
}
},
"adjudication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplanationOfBenefit_Item_Adjudication",
"description": "The adjudication results."
}
}
},
"required": [
"sequence",
"productOrService"
]
}
]
},
"ExplanationOfBenefit_Payee": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Type of Party to be reimbursed: Subscriber, provider, other."
},
"party": {
"$ref": "#/components/schemas/Reference",
"description": "Reference to the individual or organization to whom any payment will be made."
}
}
}
]
},
"ExplanationOfBenefit_Payment": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Whether this represents partial or complete payment of the benefits payable."
},
"adjustment": {
"$ref": "#/components/schemas/Money",
"description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication."
},
"adjustmentReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Reason for the payment adjustment."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Estimated date the payment will be issued or the actual issue date of payment."
},
"amount": {
"$ref": "#/components/schemas/Money",
"description": "Benefits payable less any payment adjustment."
},
"identifier": {
"$ref": "#/components/schemas/Identifier",
"description": "Issuer's unique identifier for the payment instrument."
}
}
}
]
},
"ExplanationOfBenefit_Procedure": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "A number to uniquely identify procedure entries."
},
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "When the condition was observed or the relative ranking."
}
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Date and optionally time the procedure was performed."
},
"procedureCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The code or reference to a Procedure resource which identifies the clinical intervention performed."
},
"procedureReference": {
"$ref": "#/components/schemas/Reference",
"description": "The code or reference to a Procedure resource which identifies the clinical intervention performed."
},
"udi": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Unique Device Identifiers associated with this line item."
}
}
},
"required": [
"sequence"
]
}
]
},
"ExplanationOfBenefit_ProcessNote": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int32",
"description": "A number to uniquely identify a note entry."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The business purpose of the note text."
},
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The explanation or description associated with the processing."
},
"language": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code to define the language used in the text of the note."
}
}
}
]
},
"ExplanationOfBenefit_Related": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"claim": {
"$ref": "#/components/schemas/Reference",
"description": "Reference to a related claim."
},
"relationship": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code to convey how the claims are related."
},
"reference": {
"$ref": "#/components/schemas/Identifier",
"description": "An alternate organizational reference to the case or file to which this particular claim pertains."
}
}
}
]
},
"ExplanationOfBenefit_SupportingInfo": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "A number to uniquely identify supporting information entries."
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The general class of the information supplied: information; exception; accident, employment; onset, etc."
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought."
},
"timingDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The date when or period to which this information refers."
},
"timingPeriod": {
"$ref": "#/components/schemas/Period",
"description": "The date when or period to which this information refers."
},
"valueBoolean": {
"type": "boolean",
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data."
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data."
},
"valueAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data."
},
"valueReference": {
"$ref": "#/components/schemas/Reference",
"description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data."
},
"reason": {
"$ref": "#/components/schemas/Coding",
"description": "Provides the reason in the situation where a reason code is required in addition to the content."
}
},
"required": [
"sequence",
"category"
]
}
]
},
"ExplanationOfBenefit_Total": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item."
},
"amount": {
"$ref": "#/components/schemas/Money",
"description": "Monetary total amount associated with the category."
}
},
"required": [
"category",
"amount"
]
}
]
},
"List": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifier for the List assigned for business purposes outside the context of FHIR."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates the current state of this list."
},
"mode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "How this list was prepared – whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted."
},
"title": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A label for the list assigned by the author."
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "This code defines the purpose of the list – why it was created."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "The common subject (or patient) of the resources that are in the list if there is one."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The encounter that is the context in which this list was created."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date that the list was prepared."
},
"source": {
"$ref": "#/components/schemas/Reference",
"description": "The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list."
},
"orderedBy": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "What order applies to the items in the list."
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Comments that apply to the overall list."
}
},
"entry": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List_Entry",
"description": "Entries in this list."
}
},
"emptyReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "If the list is empty, why the list is empty."
}
},
"required": [
"status",
"mode"
]
}
],
"example": {
"resourceType": "List",
"meta": {
"versionId": "NemMdmoCDw",
"lastUpdated": "2021-04-12T14:34:36.287-05:00",
"source": "lDHugw_pim",
"profile": [
"7B9FeuWdC7"
],
"security": [
{
"system": "hwq4vv4rwF",
"version": "HCvDGJaMCp",
"code": "85DyZgtsV8",
"display": "bTtlqJ9jrx",
"userSelected": true
}
],
"tag": [
{
"system": "MFMAvggXV3",
"version": "4VNe42VAOV",
"code": "ecdPF7WE6_",
"display": "D_Wqcu0yOf",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "4AuD3mw6cM",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "nXmwMdJ3rj",
"version": "HxCyOTzvFy",
"code": "TSnO9T9pC1",
"display": "CGkY1rTlLX",
"userSelected": true
}
],
"text": "0Gh9SGFbAd"
},
"system": "tBwChhqoxv",
"value": "sDXcTIAopv",
"period": {
"start": "2021-04-12T14:34:36.279-05:00",
"end": "2021-04-12T14:34:36.279-05:00"
}
}
],
"status": "retired",
"mode": "working",
"title": "XKsvdh6AYS",
"code": {
"coding": [
{
"system": "7VhyuX1GMT",
"version": "miwZ8AHBxM",
"code": "cIedkppQyq",
"display": "vY5CUkKfux",
"userSelected": true
}
],
"text": "m1Mb_0Oo73"
},
"subject": {
"reference": "Patient/YtM7h4WDbD",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "LETdSeg1si",
"version": "ZvUJllTpXn",
"code": "_P4ncJ8WzV",
"display": "ycNbznf6qT",
"userSelected": true
}
],
"text": "FaAaDHmvhv"
},
"system": "d6luGRKTJV",
"value": "3ZMuvIapU3",
"period": {
"start": "2021-04-12T14:34:36.282-05:00",
"end": "2021-04-12T14:34:36.282-05:00"
}
},
"display": "MGuqIBo74I"
},
"encounter": {
"reference": "Encounter/oqP5oiHBVT",
"type": "Encounter",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "py59Yk7EA2",
"version": "5YwssLCkNP",
"code": "crGYOIVDSK",
"display": "8wINCYfSlQ",
"userSelected": true
}
],
"text": "U5YIgr_5kh"
},
"system": "m0mHpAa9eL",
"value": "3uYlFG2hzG",
"period": {
"start": "2021-04-12T14:34:36.284-05:00",
"end": "2021-04-12T14:34:36.284-05:00"
}
},
"display": "zxQwzyR63E"
},
"date": "2021-04-12T14:34:36.287-05:00",
"source": {
"reference": "Practitioner/KjuYCObo0P",
"type": "Practitioner",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "SvXlU9YXfy",
"version": "UNLL4cQyG1",
"code": "aE8_usYKr2",
"display": "1zfO14neTe",
"userSelected": true
}
],
"text": "HJmzxWqpmd"
},
"system": "_cqPlRaNkr",
"value": "2yCM9Jnnpz",
"period": {
"start": "2021-04-12T14:34:36.283-05:00",
"end": "2021-04-12T14:34:36.283-05:00"
}
},
"display": "18u7_aw6E7"
},
"orderedBy": {
"coding": [
{
"system": "wZOS_UV5Kq",
"version": "LpWkkzOEmp",
"code": "jrLV8KfCto",
"display": "9OTYt3vpLE",
"userSelected": true
}
],
"text": "FEndgTerAj"
},
"note": [
{
"authorReference": {
"reference": "Practitioner/QcgwxJ86KC",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "vjg4Hx5o6d",
"version": "ghunQD9rp7",
"code": "r7qFFHZVW4",
"display": "Kn6J2H_ul8",
"userSelected": true
}
],
"text": "7VWFJmLMF9"
},
"system": "RD5tnd1esW",
"value": "fkw5EFRVoh",
"period": {
"start": "2021-04-12T14:34:36.28-05:00",
"end": "2021-04-12T14:34:36.28-05:00"
}
},
"display": "R_H45t8qPY"
},
"time": "2021-04-12T14:34:36.281-05:00",
"text": "J5GKHQtbAH"
}
],
"entry": [
{
"flag": {
"coding": [
{
"system": "anPoSle9cp",
"version": "pCKs0_Bvn6",
"code": "CX5jno3LpR",
"display": "LstvGtyZFJ",
"userSelected": true
}
],
"text": "TLcrWeon8f"
},
"deleted": true,
"date": "2021-04-12T14:34:36.286-05:00",
"item": {
"reference": "Basic/J9Cp-D4Fww",
"type": "Basic",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "aPkQ56VNie",
"version": "tLq6aEuPTL",
"code": "fGt6anyz6V",
"display": "k0DrcosEaQ",
"userSelected": true
}
],
"text": "w7NRTfj0WK"
},
"system": "VfvfYvoGPF",
"value": "o5nRubNitf",
"period": {
"start": "2021-04-12T14:34:36.285-05:00",
"end": "2021-04-12T14:34:36.286-05:00"
}
},
"display": "9tT7yrAT26"
}
}
],
"emptyReason": {
"coding": [
{
"system": "y7kIKI_moh",
"version": "vrQoHJH3IZ",
"code": "f9HAjkHSX4",
"display": "IexqGiN2CW",
"userSelected": true
}
],
"text": "0mBWo4prQO"
}
}
},
"List_Entry": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"flag": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The flag allows the system constructing the list to indicate the role and significance of the item in the list."
},
"deleted": {
"type": "boolean",
"description": "True if this item is marked as deleted in the list."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "When this item was added to the list."
},
"item": {
"$ref": "#/components/schemas/Reference",
"description": "A reference to the actual resource from which data was derived."
}
},
"required": [
"item"
]
}
]
},
"DocumentReference": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"masterIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document."
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Other identifiers associated with the document, including version independent identifiers."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of this document reference."
},
"docStatus": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of the underlying document."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A categorization for the type of document referenced – helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type."
}
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "When the document reference was created."
},
"author": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies who is responsible for adding the information to the document."
}
},
"authenticator": {
"$ref": "#/components/schemas/Reference",
"description": "Which person or organization authenticates that this document is valid."
},
"custodian": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."
},
"relatesTo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentReference_RelatesTo",
"description": "Relationships that this document has with other document references that already exist."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Human–readable description of the source document."
},
"securityLabel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A set of Security–Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to."
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentReference_Content",
"description": "The document and format referenced. There may be multiple content element repetitions, each with a different format."
},
"minItems": 1
},
"context": {
"$ref": "#/components/schemas/DocumentReference_Context",
"description": "The clinical context in which the document was prepared."
}
},
"required": [
"status",
"content"
]
}
],
"example": {
"resourceType": "DocumentReference",
"meta": {
"versionId": "gtFTiNf4pp",
"lastUpdated": "2021-04-12T14:34:34.01-05:00",
"source": "u1NjrkzkI9",
"profile": [
"GeX8qExU8T"
],
"security": [
{
"system": "CnHy_LhYEO",
"version": "5jgtFQbOsh",
"code": "ykt_NRVN2m",
"display": "kWifQsgkn2",
"userSelected": true
}
],
"tag": [
{
"system": "dNL6RYHvEh",
"version": "JZe571xjI9",
"code": "qfOWgGfGwa",
"display": "tLxG622FFM",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "6lVNfkBMu8",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"masterIdentifier": {
"use": "old",
"type": {
"coding": [
{
"system": "7mwyNwu55K",
"version": "yffM988UcE",
"code": "3BOy0Jxcor",
"display": "jjlmPREoGm",
"userSelected": true
}
],
"text": "ghl1nSX6YC"
},
"system": "TTrHlxfLip",
"value": "D5fA_0kdwA",
"period": {
"start": "2021-04-12T14:34:34.004-05:00",
"end": "2021-04-12T14:34:34.004-05:00"
}
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "lS5SVgd7m8",
"version": "D0f_cGPYb3",
"code": "Iwr8clnIJV",
"display": "WWKdoxQqi_",
"userSelected": true
}
],
"text": "9V8npw0pd4"
},
"system": "CdLlOyLjU1",
"value": "KVSh9dgHSm",
"period": {
"start": "2021-04-12T14:34:33.999-05:00",
"end": "2021-04-12T14:34:34-05:00"
}
}
],
"status": "superseded",
"docStatus": "amended",
"type": {
"coding": [
{
"system": "dRfGnezqS8",
"version": "v1QrmnRwbQ",
"code": "upr0MbXWgh",
"display": "jXbIcKWPkF",
"userSelected": true
}
],
"text": "VcIijzsugN"
},
"category": [
{
"coding": [
{
"system": "A7k2cP5mRe",
"version": "lTr225DJ_f",
"code": "ok1stFGDa7",
"display": "a46ixWeWBj",
"userSelected": true
}
],
"text": "3tczy6K8mz"
}
],
"subject": {
"reference": "Patient/sWaJHjRsNv",
"type": "Patient",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "sZVJfrk4hb",
"version": "WZ1Mph143n",
"code": "WFmxKMXh2Z",
"display": "KuPLtc3dyH",
"userSelected": true
}
],
"text": "CFf77IMQCj"
},
"system": "kXtDyGzwt6",
"value": "pCWwi5XqhA",
"period": {
"start": "2021-04-12T14:34:34.002-05:00",
"end": "2021-04-12T14:34:34.003-05:00"
}
},
"display": "2azTEoyPfc"
},
"date": "2021-04-12T14:34:34.009-05:00",
"author": [
{
"reference": "Practitioner/dat6us3Wuh",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "WLir5fXZvI",
"version": "brIG31Koax",
"code": "IOMdkc9pNe",
"display": "GVXgZtHeP8",
"userSelected": true
}
],
"text": "Rw7RNXxgM8"
},
"system": "Q9QbHygPMg",
"value": "wWagFX4Q0o",
"period": {
"start": "2021-04-12T14:34:33.996-05:00",
"end": "2021-04-12T14:34:33.996-05:00"
}
},
"display": "CQbhbAruWE"
}
],
"authenticator": {
"reference": "Practitioner/wziffURBSp",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "8Kmrm2wBQK",
"version": "biW6ZqUReL",
"code": "SPSNBMINwX",
"display": "T4yKMVXuv2",
"userSelected": true
}
],
"text": "pHdbq_lhSn"
},
"system": "ooZWTdZDZ7",
"value": "9s65NQY7Ps",
"period": {
"start": "2021-04-12T14:34:33.997-05:00",
"end": "2021-04-12T14:34:33.997-05:00"
}
},
"display": "tsv_lBf2Xh"
},
"custodian": {
"reference": "Organization/xQdz7LMAbe",
"type": "Organization",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "rKdu5gDhAF",
"version": "WCi5iw_hw2",
"code": "S9L30wltk1",
"display": "zryQgMABeW",
"userSelected": true
}
],
"text": "e77g9DjgrG"
},
"system": "rmqPsYs95K",
"value": "A_R82Ugl7C",
"period": {
"start": "2021-04-12T14:34:34-05:00",
"end": "2021-04-12T14:34:34-05:00"
}
},
"display": "lm5AajqYNd"
},
"relatesTo": [
{
"code": "signs",
"target": {
"reference": "DocumentReference/hM-RLCNVjU",
"type": "DocumentReference",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "7SuCx4Fj2Y",
"version": "ZApT2WuBjt",
"code": "IPftdTqi8u",
"display": "rYHXLz6oFS",
"userSelected": true
}
],
"text": "4z6kJa9fBz"
},
"system": "FbeYXzWzgF",
"value": "MNKHkIU9jF",
"period": {
"start": "2021-04-12T14:34:34.001-05:00",
"end": "2021-04-12T14:34:34.002-05:00"
}
},
"display": "fxezsRnaOp"
}
}
],
"description": "k8lgLi0g0U",
"securityLabel": [
{
"coding": [
{
"system": "Ez3uzI1Mwn",
"version": "WQicPCuVlS",
"code": "4Kz6W_788K",
"display": "ebtH3kMTAi",
"userSelected": true
}
],
"text": "VKYvFGKIcq"
}
],
"content": [
{
"attachment": {
"contentType": "qnkdEriAKi",
"language": "en-US",
"data": "KEAkP2s=",
"url": "QAML_39pMf",
"size": 1216996556,
"hash": "Sz9rIVc=",
"title": "0f8gUmMpbe",
"creation": "2021-04-12T14:34:33.995-05:00"
},
"format": {
"system": "vPcJ_AP4_Y",
"version": "nVovVd1zlP",
"code": "2waSvVDpfq",
"display": "CalkROka2S",
"userSelected": true
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/FNsCyzt4BN",
"type": "Encounter",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "WOfiWgV5Ge",
"version": "nUC92AjpfY",
"code": "rWsXWArOrU",
"display": "aGuGtmS7Uc",
"userSelected": true
}
],
"text": "Bli0bKWE1c"
},
"system": "zml7dk3gdz",
"value": "YuaZxz4SB6",
"period": {
"start": "2021-04-12T14:34:34.007-05:00",
"end": "2021-04-12T14:34:34.007-05:00"
}
},
"display": "0AV0WtxDhO"
}
],
"event": [
{
"coding": [
{
"system": "0JwJfUzpjY",
"version": "sSJoYeHXX_",
"code": "Naj3bY5Jal",
"display": "oEpirqwUVQ",
"userSelected": true
}
],
"text": "J2ZRMNDnpu"
}
],
"period": {
"start": "2021-04-12T14:34:34.005-05:00",
"end": "2021-04-12T14:34:34.005-05:00"
},
"facilityType": {
"coding": [
{
"system": "iJf7tYTgRI",
"version": "ljYQ5xsuWr",
"code": "NGHdAde7W6",
"display": "3Wo0EpCWG6",
"userSelected": true
}
],
"text": "n0hnnT13Nu"
},
"practiceSetting": {
"coding": [
{
"system": "1545J6V3Ou",
"version": "5lyBpxd0pe",
"code": "RrOvA1oUzY",
"display": "hMwANtKfd4",
"userSelected": true
}
],
"text": "66o72vxTG8"
},
"sourcePatientInfo": {
"reference": "Patient/ViGKrDHYS3",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "41qAmtaJu9",
"version": "YxGqwVxLmU",
"code": "lHDLBSP_6R",
"display": "La92gyRePJ",
"userSelected": true
}
],
"text": "jUNMEcfFQn"
},
"system": "5FGzR43kw6",
"value": "ceF9qwCw7Y",
"period": {
"start": "2021-04-12T14:34:34.008-05:00",
"end": "2021-04-12T14:34:34.008-05:00"
}
},
"display": "g7xaLj8bf4"
},
"related": [
{
"reference": "Basic/EuipjRjEHI",
"type": "Basic",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "hEj1nOEFgh",
"version": "GLHUYRu3Wb",
"code": "xTOuf7_8Pe",
"display": "PxOpZ2F7aH",
"userSelected": true
}
],
"text": "I1ArFo90cZ"
},
"system": "1Iqq1r69bi",
"value": "Vb8DWppzxd",
"period": {
"start": "2021-04-12T14:34:34.006-05:00",
"end": "2021-04-12T14:34:34.006-05:00"
}
},
"display": "moc4oDijFi"
}
]
}
}
},
"DocumentReference_Content": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"attachment": {
"$ref": "#/components/schemas/Attachment",
"description": "The document or URL of the document along with critical metadata to prove content has integrity."
},
"format": {
"$ref": "#/components/schemas/Coding",
"description": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType."
}
},
"required": [
"attachment"
]
}
]
},
"DocumentReference_Context": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"encounter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Describes the clinical encounter or type of care that the document content is associated with."
}
},
"event": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act."
}
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The time period over which the service that is described by the document was provided."
},
"facilityType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The kind of facility where the patient was seen."
},
"practiceSetting": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty."
},
"sourcePatientInfo": {
"$ref": "#/components/schemas/Reference",
"description": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained."
},
"related": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Related identifiers or resources associated with the DocumentReference."
}
}
}
}
]
},
"DocumentReference_RelatesTo": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The type of relationship that this document has with anther document."
},
"target": {
"$ref": "#/components/schemas/Reference",
"description": "The target document of this relationship."
}
},
"required": [
"code",
"target"
]
}
]
},
"Observation": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A unique identifier assigned to this observation."
}
},
"basedOn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed."
}
},
"partOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of the result value."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code that classifies the general type of observation being made."
}
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Describes what was observed. Sometimes this is called the observation \"name\"."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation."
},
"focus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus."
}
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made."
},
"effectiveDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The time or time–period the observed value is asserted as being true. For biological subjects – e.g. human patients – this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself."
},
"effectivePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The time or time–period the observed value is asserted as being true. For biological subjects – e.g. human patients – this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself."
},
"effectiveTiming": {
"$ref": "#/components/schemas/Timing",
"description": "The time or time–period the observed value is asserted as being true. For biological subjects – e.g. human patients – this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself."
},
"effectiveInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The time or time–period the observed value is asserted as being true. For biological subjects – e.g. human patients – this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself."
},
"issued": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified."
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Who was responsible for asserting the observed value as \"true\"."
}
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueBoolean": {
"type": "boolean",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueInteger": {
"type": "integer",
"format": "int32",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueRange": {
"$ref": "#/components/schemas/Range",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valuePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"dataAbsentReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Provides a reason why the expected value in the element Observation.value[x] is missing."
},
"interpretation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A categorical assessment of an observation value. For example, high, low, normal."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Comments about the observation or the results."
}
},
"bodySite": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the site on the subject's body where the observation was made (i.e. the target site)."
},
"method": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the mechanism used to perform the observation."
},
"specimen": {
"$ref": "#/components/schemas/Reference",
"description": "The specimen that was used when this observation was made."
},
"device": {
"$ref": "#/components/schemas/Reference",
"description": "The device used to generate the observation data."
},
"referenceRange": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Observation_ReferenceRange",
"description": "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used."
}
},
"hasMember": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group."
}
},
"derivedFrom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image."
}
},
"component": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Observation_Component",
"description": "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations."
}
}
},
"required": [
"status",
"code"
]
}
],
"example": {
"resourceType": "Observation",
"meta": {
"versionId": "hdvWPRDvOS",
"lastUpdated": "2021-04-12T14:34:32.772-05:00",
"source": "XmGryjKimj",
"profile": [
"a7LJoaU1od"
],
"security": [
{
"system": "t7ZhkC5I8G",
"version": "iSAZuDw0p0",
"code": "Nz9HCPi1JL",
"display": "t3HkILgGgv",
"userSelected": true
}
],
"tag": [
{
"system": "tKzH7_HnAP",
"version": "q8Iy6Ul9kF",
"code": "ihZxv03V_M",
"display": "EfW8CZXyzq",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "Mcy3pNkln1",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "old",
"type": {
"coding": [
{
"system": "k0y_LnHMyW",
"version": "kRwqR6I_MO",
"code": "hGuztA2OQf",
"display": "VD_gd0cXg_",
"userSelected": true
}
],
"text": "vRZmp42p_F"
},
"system": "QiBdIXq09w",
"value": "dXHSYkdzql",
"period": {
"start": "2021-04-12T14:34:32.758-05:00",
"end": "2021-04-12T14:34:32.759-05:00"
}
}
],
"basedOn": [
{
"reference": "CarePlan/iHzNdaymYx",
"type": "CarePlan",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "7vjE0PVruW",
"version": "x0QnJNc8_H",
"code": "Fo8NGkohw1",
"display": "UMr86xzHkU",
"userSelected": true
}
],
"text": "XU7CUQEh00"
},
"system": "cpKCcFbTJE",
"value": "HH1Z66Vqgt",
"period": {
"start": "2021-04-12T14:34:32.758-05:00",
"end": "2021-04-12T14:34:32.758-05:00"
}
},
"display": "Ws2t3ODWfx"
}
],
"partOf": [
{
"reference": "MedicationAdministration/pgtagfJmco",
"type": "MedicationAdministration",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "GGr9zcAey9",
"version": "Qn4yJkMC3x",
"code": "ghzVrEMwUj",
"display": "8PZ5YDKFSq",
"userSelected": true
}
],
"text": "StYHC7e9JO"
},
"system": "1v_gTw4QA9",
"value": "VOO8nFoUUZ",
"period": {
"start": "2021-04-12T14:34:32.757-05:00",
"end": "2021-04-12T14:34:32.757-05:00"
}
},
"display": "WbjdG14QK7"
}
],
"status": "corrected",
"category": [
{
"coding": [
{
"system": "cOIwJecY_B",
"version": "OrlpoFAIIl",
"code": "mrk1rTk2I4",
"display": "ZBgstiBPFB",
"userSelected": true
}
],
"text": "ydkHept5nr"
}
],
"code": {
"coding": [
{
"system": "Q8j8FFcHSM",
"version": "Aam6z1xssw",
"code": "ypBw09iKnC",
"display": "gRXdSDv64D",
"userSelected": true
}
],
"text": "IVryHVcXXZ"
},
"subject": {
"reference": "Patient/hBtU-AlqDq",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "aIoDD1RWDt",
"version": "bQjfMh9oge",
"code": "qE4f7fcYc1",
"display": "jheHFSnw7R",
"userSelected": true
}
],
"text": "cIiicq14bb"
},
"system": "AxeMelQxrz",
"value": "1J58A2cxYo",
"period": {
"start": "2021-04-12T14:34:32.769-05:00",
"end": "2021-04-12T14:34:32.769-05:00"
}
},
"display": "OUYPo4rpXb"
},
"focus": [
{
"reference": "Basic/8PS1b8YlLw",
"type": "Basic",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "wOE7EUCv19",
"version": "jwn4w6Ln0T",
"code": "yLklDEbanT",
"display": "gURCcT8afV",
"userSelected": true
}
],
"text": "K_PksP50Tc"
},
"system": "qD0DXd8rWe",
"value": "ml_p6eDqVQ",
"period": {
"start": "2021-04-12T14:34:32.763-05:00",
"end": "2021-04-12T14:34:32.763-05:00"
}
},
"display": "0A36snT3zo"
}
],
"encounter": {
"reference": "Encounter/rpRcyNO5Hd",
"type": "Encounter",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "rvZDXrj1ZE",
"version": "eTJYGvadlj",
"code": "ZOeMKRleV8",
"display": "xnlL6ofc1I",
"userSelected": true
}
],
"text": "5F9At9YIBF"
},
"system": "FZbmkjU1xS",
"value": "tRDVIr5jpi",
"period": {
"start": "2021-04-12T14:34:32.77-05:00",
"end": "2021-04-12T14:34:32.77-05:00"
}
},
"display": "xfjoNJmBlW"
},
"effectiveDateTime": "2021-04-12T14:34:32.771-05:00",
"issued": "2021-04-12T14:34:32.771-05:00",
"performer": [
{
"reference": "Practitioner/JsEssySODp",
"type": "Practitioner",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "SbE3JxucFt",
"version": "4hmQzTCLtN",
"code": "r9rBFM6QTS",
"display": "qJsXO1ytJb",
"userSelected": true
}
],
"text": "VNosXgzK5Z"
},
"system": "EYYLIRQRP9",
"value": "2IHAaawzXp",
"period": {
"start": "2021-04-12T14:34:32.762-05:00",
"end": "2021-04-12T14:34:32.762-05:00"
}
},
"display": "Uf8kTH5FsT"
}
],
"valueQuantity": {
"value": 246244780807,
"comparator": "<",
"unit": "p6pXssGtzu",
"system": "6uErJT8VXL",
"code": "PZmqgUQZ2J"
},
"interpretation": [
{
"coding": [
{
"system": "fTd2Mu4zFS",
"version": "K15yRBz85a",
"code": "NVGApAgPZV",
"display": "jYDXh80WTZ",
"userSelected": true
}
],
"text": "pVpHv6VG_M"
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/WJmopwgWGF",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "fenqqW3NWS",
"version": "2jYyFYnLsp",
"code": "JzxuQs6ZT6",
"display": "lxWZRKCC65",
"userSelected": true
}
],
"text": "yWk85Ta4hy"
},
"system": "RUSkQfms6n",
"value": "pxX10pCoax",
"period": {
"start": "2021-04-12T14:34:32.765-05:00",
"end": "2021-04-12T14:34:32.765-05:00"
}
},
"display": "meapi5e0RH"
},
"time": "2021-04-12T14:34:32.765-05:00",
"text": "FaxTayyhP1"
}
],
"bodySite": {
"coding": [
{
"system": "34XiDjBBx9",
"version": "txWWjngjC6",
"code": "tNvQXRF_NR",
"display": "b_shB6dNhs",
"userSelected": true
}
],
"text": "8aNI8yUgjl"
},
"method": {
"coding": [
{
"system": "pndypIxysP",
"version": "KpCm0q8E9C",
"code": "xtQoqIZLFm",
"display": "lg0VEAEEOf",
"userSelected": true
}
],
"text": "9dkIpbFdRN"
},
"specimen": {
"reference": "Specimen/4Njqs6SW7-",
"type": "Specimen",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "ZIXfvttaYK",
"version": "35Ik44pclU",
"code": "_aDudMV9Yv",
"display": "jGqvofXqto",
"userSelected": true
}
],
"text": "ADcXtLnUfR"
},
"system": "uHZFmI7Vwj",
"value": "6fwgVWRH6G",
"period": {
"start": "2021-04-12T14:34:32.761-05:00",
"end": "2021-04-12T14:34:32.761-05:00"
}
},
"display": "GwbbnRmV2B"
},
"device": {
"reference": "Device/CGRl0Vcsje",
"type": "Device",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "FQWfQQHQqZ",
"version": "bZkvbyMigN",
"code": "QntjlJgn7f",
"display": "91_Pd7u9Um",
"userSelected": true
}
],
"text": "XDDLewYDwn"
},
"system": "fIi8sw6qFU",
"value": "nNmd6Kc_Pl",
"period": {
"start": "2021-04-12T14:34:32.76-05:00",
"end": "2021-04-12T14:34:32.76-05:00"
}
},
"display": "7fvc8Z9wrm"
},
"referenceRange": [
{
"low": {
"value": 109036918092,
"unit": "wE4yPug5fq",
"system": "nTfb3B9PBc",
"code": "ak0XaMhRa3"
},
"high": {
"value": 370378687491,
"unit": "i0HW644nOA",
"system": "ZrpiWICYpS",
"code": "xZCCmDHhwv"
},
"type": {
"coding": [
{
"system": "vaqY4tN41H",
"version": "VAjK0GwQ7t",
"code": "gTw4RSUe41",
"display": "YY98QT7XEo",
"userSelected": true
}
],
"text": "NHNbqvE__g"
},
"appliesTo": [
{
"coding": [
{
"system": "DtnKFgleSb",
"version": "rFWhChabE0",
"code": "u1ttDxab68",
"display": "HDGfAabLuO",
"userSelected": true
}
],
"text": "aEw6ReioLa"
}
],
"age": {
"low": {
"value": 512315697938,
"unit": "Qqlk6LSWiY",
"system": "qf59lFOd3x",
"code": "3okKB4RFqo"
}
},
"text": "P8H36ltR7t"
}
],
"hasMember": [
{
"reference": "Observation/kji-k3X3fG",
"type": "Observation",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "rblmByESnO",
"version": "ZHJwL6nBWY",
"code": "IKG9XpFriE",
"display": "c0vLM0lCEa",
"userSelected": true
}
],
"text": "P3X5UBBI02"
},
"system": "6zO4bIamhE",
"value": "aUScd6PJTZ",
"period": {
"start": "2021-04-12T14:34:32.775-05:00",
"end": "2021-04-12T14:34:32.775-05:00"
}
},
"display": "e8VDikL6Zp"
}
],
"derivedFrom": [
{
"reference": "DocumentReference/bPme6RbJg5",
"type": "DocumentReference",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "hKq1OftsVN",
"version": "STjwULNaQN",
"code": "lZ6Rt_AVK7",
"display": "WdDS6hF2Yd",
"userSelected": true
}
],
"text": "6KvgfkSbVU"
},
"system": "eKeJh56Umu",
"value": "6mJOFVMw5r",
"period": {
"start": "2021-04-12T14:34:32.759-05:00",
"end": "2021-04-12T14:34:32.759-05:00"
}
},
"display": "tsFWUWcqme"
}
],
"component": [
{
"code": {
"coding": [
{
"system": "_ehGhhMBg7",
"version": "GId9UfFyIO",
"code": "ZrMidyTfls",
"display": "FR1VWbFLhd",
"userSelected": true
}
],
"text": "cbBZT3RLd2"
},
"valueQuantity": {
"value": 169102677880,
"comparator": ">=",
"unit": "48nmbqKvER",
"system": "uWfc7GH5pQ",
"code": "nLECgpzULI"
},
"dataAbsentReason": {
"coding": [
{
"system": "WUtEpmOjYB",
"version": "PcgOmpswop",
"code": "tvnQ0BcFG7",
"display": "7YCycJPwpe",
"userSelected": true
}
],
"text": "DrvxKpOqQJ"
},
"interpretation": [
{
"coding": [
{
"system": "jA8ipO2HEx",
"version": "qhjac1I1G4",
"code": "ybFqTinZ2V",
"display": "m5Ao8fDQNy",
"userSelected": true
}
],
"text": "VCJTLoQ8xZ"
}
],
"referenceRange": [
{
"low": {
"value": 357547510112,
"unit": "Fgvs2NxauG",
"system": "jHBP3iWaKS",
"code": "JWetlbMK4T"
},
"high": {
"value": 302296034876,
"unit": "tFzcWUmyGV",
"system": "B5sQK5we2I",
"code": "mlrCoBPeLL"
},
"type": {
"coding": [
{
"system": "04uult7jR1",
"version": "wuPN_7pd87",
"code": "dru52L5LcD",
"display": "G3qoEYqj3w",
"userSelected": true
}
],
"text": "0MCUyWTBj6"
},
"appliesTo": [
{
"coding": [
{
"system": "mxzixMNd6M",
"version": "vwN3_WnneN",
"code": "HH69OoVwDq",
"display": "llD_PZ6d7I",
"userSelected": true
}
],
"text": "eWDgRukTBb"
}
],
"age": {
"low": {
"value": 292431221556,
"unit": "CzUS5jExT9",
"system": "I_0jUg88ke",
"code": "RIKatcWIMH"
}
},
"text": "UErOzxR6Ma"
}
]
}
]
}
},
"Observation_Component": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Describes what was observed. Sometimes this is called the observation \"code\"."
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueBoolean": {
"type": "boolean",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueInteger": {
"type": "integer",
"format": "int32",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueRange": {
"$ref": "#/components/schemas/Range",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"valuePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The information determined as a result of making the observation, if the information has a simple value."
},
"dataAbsentReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Provides a reason why the expected value in the element Observation.component.value[x] is missing."
},
"interpretation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A categorical assessment of an observation value. For example, high, low, normal."
}
},
"referenceRange": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Observation_ReferenceRange",
"description": "Guidance on how to interpret the value by comparison to a normal or recommended range."
}
}
},
"required": [
"code"
]
}
]
},
"Observation_ReferenceRange": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"low": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 – <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3)."
},
"high": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 – <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3)."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range."
},
"appliesTo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used."
}
},
"age": {
"$ref": "#/components/schemas/Range",
"description": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so."
},
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\"."
}
}
}
]
},
"MedicationAdministration": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server."
}
},
"instantiates": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event."
}
},
"partOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A larger event of which this particular event is a component or step."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way."
},
"statusReason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code indicating why the administration was not performed."
}
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates where the medication is expected to be consumed or administered."
},
"medicationCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications."
},
"medicationReference": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "The person or animal or group receiving the medication."
},
"context": {
"$ref": "#/components/schemas/Reference",
"description": "The visit, admission, or other contact between patient and health care provider during which the medication administration was performed."
},
"supportingInformation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Additional information (for example, patient height and weight) that supports the administration of the medication."
}
},
"effectiveDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate."
},
"effectivePeriod": {
"$ref": "#/components/schemas/Period",
"description": "A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate."
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MedicationAdministration_Performer",
"description": "Indicates who or what performed the medication administration and how they were involved."
}
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code indicating why the medication was given."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Condition or observation that supports why the medication was administered."
}
},
"request": {
"$ref": "#/components/schemas/Reference",
"description": "The original request, instruction or authority to perform the administration."
},
"device": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The device used in administering the medication to the patient. For example, a particular infusion pump."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Extra information about the medication administration that is not conveyed by the other attributes."
}
},
"dosage": {
"$ref": "#/components/schemas/MedicationAdministration_Dosage",
"description": "Describes the medication dosage information details e.g. dose, rate, site, route, etc."
},
"eventHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A summary of the events of interest that have occurred, such as when the administration was verified."
}
}
},
"required": [
"status",
"subject"
]
}
],
"example": {
"resourceType": "MedicationAdministration",
"meta": {
"versionId": "hEZgXQT-pU",
"lastUpdated": "2021-04-12T14:34:38.057-05:00",
"source": "_AFF3pD9rS",
"profile": [
"s5o0QMnXiS"
],
"security": [
{
"system": "jW47m2DsJL",
"version": "B07q5cRIZV",
"code": "EYsDxy0Kg7",
"display": "eZpgIwR6R4",
"userSelected": true
}
],
"tag": [
{
"system": "QfAD43K8jQ",
"version": "RualjQ_pXX",
"code": "qQwi0GD3T7",
"display": "CqAQ07vpdO",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "e4vwByqqCP",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "uF8sNfiJuB",
"version": "xXWAsFQa_i",
"code": "4UF4631gtV",
"display": "9Yo4vmu8Xd",
"userSelected": true
}
],
"text": "9PqNhJHg2g"
},
"system": "pTfRYyVwv4",
"value": "2sHW7PI2Gt",
"period": {
"start": "2021-04-12T14:34:38.044-05:00",
"end": "2021-04-12T14:34:38.045-05:00"
}
}
],
"instantiates": [
"5L0zmxIFrI"
],
"partOf": [
{
"reference": "MedicationAdministration/aKihERgMT1",
"type": "MedicationAdministration",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "3DLC8EwcMK",
"version": "AF3RQOefXR",
"code": "WPEyyAJ1V9",
"display": "qnlzYeqt_B",
"userSelected": true
}
],
"text": "q1o7R6plab"
},
"system": "YaRi4EF7b6",
"value": "9jdhc4FVT8",
"period": {
"start": "2021-04-12T14:34:38.039-05:00",
"end": "2021-04-12T14:34:38.04-05:00"
}
},
"display": "cPWmD_6qLg"
}
],
"status": "unknown",
"statusReason": [
{
"coding": [
{
"system": "zUfs7F_OFn",
"version": "sjuMnZ_wla",
"code": "KKOhjHdKKS",
"display": "tatRwHKCSN",
"userSelected": true
}
],
"text": "t_2lnVJjxj"
}
],
"category": {
"coding": [
{
"system": "yHUgH9pEbs",
"version": "OlYx4hXBCr",
"code": "XiQiRcb18V",
"display": "XCDLkxJ7a2",
"userSelected": true
}
],
"text": "C4dzBOI7sI"
},
"medicationCodeableConcept": {
"coding": [
{
"system": "GQwOGfMKGG",
"version": "2LPnLRY8dj",
"code": "zIUY3wHosk",
"display": "GcZlIqrvd7",
"userSelected": true
}
],
"text": "mOCyxqPCcG"
},
"subject": {
"reference": "Patient/YzZPfaoDRU",
"type": "Patient",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "Rt2h4Ud8_m",
"version": "4Iv7xaaGDs",
"code": "majcJJQEyv",
"display": "Hz1uG_frNn",
"userSelected": true
}
],
"text": "t1aP3HBosJ"
},
"system": "COkjvEDZyB",
"value": "NoNvwjWAyb",
"period": {
"start": "2021-04-12T14:34:38.054-05:00",
"end": "2021-04-12T14:34:38.054-05:00"
}
},
"display": "gy3pV50fes"
},
"context": {
"reference": "Encounter/Ynj86vAlND",
"type": "Encounter",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "qf6Jsqlxlu",
"version": "Cq673GQpbx",
"code": "mqcvl4vIKb",
"display": "ZPS5mHpHXS",
"userSelected": true
}
],
"text": "9RpeC5vvbQ"
},
"system": "juDuzZeUCz",
"value": "Qj_Nb7ddVS",
"period": {
"start": "2021-04-12T14:34:38.056-05:00",
"end": "2021-04-12T14:34:38.056-05:00"
}
},
"display": "DysfrQ07MQ"
},
"supportingInformation": [
{
"reference": "Basic/GvnbRJE0x5",
"type": "Basic",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "o3semGjz0q",
"version": "FWh3PR7D8M",
"code": "1thnHpTFYZ",
"display": "E0g135bQaN",
"userSelected": true
}
],
"text": "j6y8EiYySH"
},
"system": "_HZDG8Fnv7",
"value": "RcUIU_W84D",
"period": {
"start": "2021-04-12T14:34:38.043-05:00",
"end": "2021-04-12T14:34:38.043-05:00"
}
},
"display": "QTG9tgLeSy"
}
],
"effectiveDateTime": "2021-04-12T14:34:38.056-05:00",
"performer": [
{
"function": {
"coding": [
{
"system": "p3lSKVVtiI",
"version": "vTQC5UBV1c",
"code": "EW__S68zQD",
"display": "hx4TIg4p7D",
"userSelected": true
}
],
"text": "zIjNI41vmz"
},
"actor": {
"reference": "Practitioner/54RZ8akKHE",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "XQULMga9hu",
"version": "GAXYoVbs0Z",
"code": "HQ9VvlwGf0",
"display": "7girNh80US",
"userSelected": true
}
],
"text": "N4Y3fDVhFC"
},
"system": "Kk9AjWnSl7",
"value": "HyZodFCcVh",
"period": {
"start": "2021-04-12T14:34:38.051-05:00",
"end": "2021-04-12T14:34:38.051-05:00"
}
},
"display": "lSyR_JnhxE"
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "0RdA7qVWUz",
"version": "Ugms5yqGcG",
"code": "jqElDz5gM8",
"display": "zKZhHdsVVl",
"userSelected": true
}
],
"text": "9LTG1e2NdN"
}
],
"reasonReference": [
{
"reference": "Condition/hC1ZBAJvDY",
"type": "Condition",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "w_rOxZNX0Y",
"version": "nhUYmVYlZ_",
"code": "kLTn3xKjNF",
"display": "L9lYu5HjHk",
"userSelected": true
}
],
"text": "Mwi8F4p6en"
},
"system": "9mlX78FAiR",
"value": "qu4AYWr5aH",
"period": {
"start": "2021-04-12T14:34:38.041-05:00",
"end": "2021-04-12T14:34:38.042-05:00"
}
},
"display": "4dOTSLU5gX"
}
],
"request": {
"reference": "MedicationRequest/6MvmkHm-0G",
"type": "MedicationRequest",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "En7vUXO5P3",
"version": "XJvfUUzsnK",
"code": "SVlai5wuUF",
"display": "NpMVH5ROVf",
"userSelected": true
}
],
"text": "7a_kWtsZDv"
},
"system": "SaJP_3_rJl",
"value": "k9rbeU4Eib",
"period": {
"start": "2021-04-12T14:34:38.055-05:00",
"end": "2021-04-12T14:34:38.055-05:00"
}
},
"display": "_YUcWhJuKQ"
},
"device": [
{
"reference": "Device/XGzCNHgsAm",
"type": "Device",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "7d6vbnI5L2",
"version": "Y4eOSMCm_5",
"code": "u6Vru8Jsb9",
"display": "9u9Yp_I9XZ",
"userSelected": true
}
],
"text": "oPD6cdBPPb"
},
"system": "TNKtMrvD91",
"value": "zhJZWaIgZ_",
"period": {
"start": "2021-04-12T14:34:38.046-05:00",
"end": "2021-04-12T14:34:38.046-05:00"
}
},
"display": "wv0rigpfrC"
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/Rkt8zCLYfG",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "s1nkLghhvP",
"version": "W6mJnPHt1G",
"code": "kISBarda6l",
"display": "abRsCQVgIU",
"userSelected": true
}
],
"text": "XPU1b01OAG"
},
"system": "gDraTHDjRl",
"value": "hXHmAnEkKc",
"period": {
"start": "2021-04-12T14:34:38.052-05:00",
"end": "2021-04-12T14:34:38.053-05:00"
}
},
"display": "nXZbJtW64B"
},
"time": "2021-04-12T14:34:38.053-05:00",
"text": "Tihb8sEJBr"
}
],
"dosage": {
"text": "zKqxw7JOjs",
"site": {
"coding": [
{
"system": "W9lBhWDXbY",
"version": "hpCw_O0J30",
"code": "2j_4Dtelm5",
"display": "xouwFncQ0o",
"userSelected": true
}
],
"text": "QPuxNs9lAl"
},
"route": {
"coding": [
{
"system": "S58_USSAvD",
"version": "y5IjtFrR8w",
"code": "knHTB_OAVu",
"display": "gCaU9MFvTi",
"userSelected": true
}
],
"text": "3NLZ1OkFn9"
},
"method": {
"coding": [
{
"system": "0Tq7sQk5_R",
"version": "xd4JqsTzvB",
"code": "HBsfqJY8Pi",
"display": "Oh2SmVJvfs",
"userSelected": true
}
],
"text": "_Vhz9Rk7z3"
},
"dose": {
"value": 36328838269,
"unit": "CJtTdHD0fP",
"system": "Rf_MOcjStO",
"code": "T9TJZu4wjI"
},
"rateRatio": {
"numerator": {
"value": 189449247331,
"comparator": "<",
"unit": "LWe06VjRzP",
"system": "q8ffrVcXt0",
"code": "Rvj8D1dMC3"
},
"denominator": {
"value": 442688301372,
"comparator": ">=",
"unit": "_LLWYz79QM",
"system": "LazokgYe0A",
"code": "QkMfr8PGI0"
}
}
},
"eventHistory": [
{
"reference": "Provenance/jM6257jOYQ",
"type": "Provenance",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "f05TZmuyLb",
"version": "1rg0ATwjEA",
"code": "4fv719oKAH",
"display": "LWSNhVVDJG",
"userSelected": true
}
],
"text": "qUuze6jQsk"
},
"system": "yNQe6iyHrA",
"value": "fDN8Rcz5OE",
"period": {
"start": "2021-04-12T14:34:38.058-05:00",
"end": "2021-04-12T14:34:38.058-05:00"
}
},
"display": "TYEmc5LpGO"
}
]
}
},
"MedicationAdministration_Dosage": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered."
},
"site": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\"."
},
"route": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc."
},
"method": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV."
},
"dose": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection."
},
"rateRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours."
},
"rateQuantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours."
}
}
}
]
},
"MedicationAdministration_Performer": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"function": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Distinguishes the type of involvement of the performer in the medication administration."
},
"actor": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates who or what performed the medication administration."
}
},
"required": [
"actor"
]
}
]
},
"Encounter": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifier(s) by which this encounter is known."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "planned | arrived | triaged | in–progress | onleave | finished | cancelled +."
},
"statusHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Encounter_StatusHistory",
"description": "The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them."
}
},
"class": {
"$ref": "#/components/schemas/Coding",
"description": "Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations."
},
"classHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Encounter_ClassHistory",
"description": "The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re–processing and not get lost or cancelled during a kind of discharge from emergency to inpatient."
}
},
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Specific type of encounter (e.g. e–mail consultation, surgical day–care, skilled nursing, rehabilitation)."
}
},
"serviceType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Broad categorization of the service that is to be provided (e.g. cardiology)."
},
"priority": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the urgency of the encounter."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "The patient or group present at the encounter."
},
"episodeOfCare": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years)."
}
},
"basedOn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The request this encounter satisfies (e.g. incoming referral or procedure request)."
}
},
"participant": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Encounter_Participant",
"description": "The list of people responsible for providing the service."
}
},
"appointment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The appointment that scheduled this encounter."
}
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The time that the episode was in the specified status."
},
"length": {
"$ref": "#/components/schemas/Duration",
"description": "Quantity of time the encounter lasted. This excludes the time during leaves of absence."
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis."
}
},
"diagnosis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Encounter_Diagnosis",
"description": "The list of diagnosis relevant to this encounter."
}
},
"account": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The set of accounts that may be used for billing for this Encounter."
}
},
"hospitalization": {
"$ref": "#/components/schemas/Encounter_Hospitalization",
"description": "Details about the admission to a healthcare service."
},
"location": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Encounter_Location",
"description": "List of locations where the patient has been during this encounter."
}
},
"serviceProvider": {
"$ref": "#/components/schemas/Reference",
"description": "The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy."
},
"partOf": {
"$ref": "#/components/schemas/Reference",
"description": "Another Encounter of which this encounter is a part of (administratively or in time)."
}
},
"required": [
"status",
"class"
]
}
],
"example": {
"resourceType": "Encounter",
"meta": {
"versionId": "9ih3chczGZ",
"lastUpdated": "2021-04-12T14:34:33.633-05:00",
"source": "pMBOMuYkJ5",
"profile": [
"1mmIdIY8AO"
],
"security": [
{
"system": "oiAQYuGjZe",
"version": "Zp8ZjvQqmD",
"code": "hPksyYzcFD",
"display": "JONJhVY6TK",
"userSelected": true
}
],
"tag": [
{
"system": "LCI7Wg5htK",
"version": "7x7pN703nC",
"code": "VMb0MRyM3H",
"display": "n6_Cs0LG1R",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "LGtELygjcv",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "Wrg32BNZ32",
"version": "7YO94pErv2",
"code": "7VOPoRSd8O",
"display": "hLqTbkvwcy",
"userSelected": true
}
],
"text": "7h83m81aDR"
},
"system": "_uSAVsHcE6",
"value": "3JG4IrDJPw",
"period": {
"start": "2021-04-12T14:34:33.622-05:00",
"end": "2021-04-12T14:34:33.622-05:00"
}
}
],
"status": "finished",
"statusHistory": [
{
"status": "cancelled",
"period": {
"start": "2021-04-12T14:34:33.611-05:00",
"end": "2021-04-12T14:34:33.611-05:00"
}
}
],
"class": {
"system": "PT7OuoNu2f",
"version": "v3Ee2czZjA",
"code": "JhR6G9pUIG",
"display": "_7K0LpkSb3",
"userSelected": true
},
"classHistory": [
{
"class": {
"system": "7QqUDivenL",
"version": "1qCzQpkc3x",
"code": "gNv4HYTDtk",
"display": "WWJSDyWfBh",
"userSelected": true
},
"period": {
"start": "2021-04-12T14:34:33.612-05:00",
"end": "2021-04-12T14:34:33.612-05:00"
}
}
],
"type": [
{
"coding": [
{
"system": "DtA_2qYaU5",
"version": "EM6Ve0XMLg",
"code": "YgZc2lapQG",
"display": "QxlUzIGgaY",
"userSelected": true
}
],
"text": "67t8Hfju8E"
}
],
"serviceType": {
"coding": [
{
"system": "px0PjTgHob",
"version": "8DrPL1eVxs",
"code": "XKiQ0pw2qA",
"display": "UTU52h5Bsk",
"userSelected": true
}
],
"text": "8ZKCCdtBiR"
},
"priority": {
"coding": [
{
"system": "qK1QmnKrT6",
"version": "73e35OqpYp",
"code": "lFbxkR4f0S",
"display": "PckCE0H836",
"userSelected": true
}
],
"text": "eeQtOy_3nQ"
},
"subject": {
"reference": "Patient/PCAK0QGOQT",
"type": "Patient",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "hstmYE5YsU",
"version": "HnAeE7NyN2",
"code": "KPrvwnmyDr",
"display": "kZHFeuorQ3",
"userSelected": true
}
],
"text": "ITUbQOWBc9"
},
"system": "SfKfEHbXri",
"value": "ObalTt3yPw",
"period": {
"start": "2021-04-12T14:34:33.627-05:00",
"end": "2021-04-12T14:34:33.627-05:00"
}
},
"display": "SuhuXLrcEC"
},
"episodeOfCare": [
{
"reference": "EpisodeOfCare/Om2SqcWQOo",
"type": "EpisodeOfCare",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "iDuk3jXFsP",
"version": "R96FkTiPXP",
"code": "ONKu6MvFnV",
"display": "R5vL21A1cM",
"userSelected": true
}
],
"text": "RXIrh9iFad"
},
"system": "5o5lerq6xF",
"value": "l_VI0VQt98",
"period": {
"start": "2021-04-12T14:34:33.624-05:00",
"end": "2021-04-12T14:34:33.624-05:00"
}
},
"display": "aegH7ItAwe"
}
],
"basedOn": [
{
"reference": "ServiceRequest/LEQA5lsXb0",
"type": "ServiceRequest",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "v7JTIif6DH",
"version": "K2uTTXqekJ",
"code": "URzqptUx4c",
"display": "_kF4SHQd8l",
"userSelected": true
}
],
"text": "mrsHIgFDGu"
},
"system": "1nnlZuFZEm",
"value": "gKvuRkYQF3",
"period": {
"start": "2021-04-12T14:34:33.62-05:00",
"end": "2021-04-12T14:34:33.62-05:00"
}
},
"display": "CD1cvyLF7G"
}
],
"participant": [
{
"type": [
{
"coding": [
{
"system": "uDdwg37y5X",
"version": "wBctJxK51b",
"code": "wBeG_sSk9a",
"display": "L_xEHwOOu3",
"userSelected": true
}
],
"text": "omSiT1HHg9"
}
],
"period": {
"start": "2021-04-12T14:34:33.621-05:00",
"end": "2021-04-12T14:34:33.621-05:00"
},
"individual": {
"reference": "Practitioner/LmfZAEAAp-",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "ho98XXAlWt",
"version": "hSLg0U_nM5",
"code": "D69mKLXCRW",
"display": "_1qFKlbBW0",
"userSelected": true
}
],
"text": "HD6SOVy3h1"
},
"system": "E4yBjWmjX6",
"value": "YAS2RFy_ke",
"period": {
"start": "2021-04-12T14:34:33.621-05:00",
"end": "2021-04-12T14:34:33.621-05:00"
}
},
"display": "LZIsz829PS"
}
}
],
"appointment": [
{
"reference": "Appointment/i9XtLy0ppQ",
"type": "Appointment",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "KIdEhKExKE",
"version": "TdYOileZgj",
"code": "9Wtfa_fpfj",
"display": "bLrCq42AI2",
"userSelected": true
}
],
"text": "G6rdxzt5b4"
},
"system": "AaQ1y3uGS9",
"value": "i0L381bBpw",
"period": {
"start": "2021-04-12T14:34:33.624-05:00",
"end": "2021-04-12T14:34:33.624-05:00"
}
},
"display": "ZvH65J2Ht8"
}
],
"period": {
"start": "2021-04-12T14:34:33.622-05:00",
"end": "2021-04-12T14:34:33.622-05:00"
},
"length": {
"value": 525381877800,
"comparator": ">",
"unit": "qS9ImImXON",
"system": "http://unitsofmeasure.org",
"code": "h"
},
"reasonCode": [
{
"coding": [
{
"system": "Juml0yXXiq",
"version": "IjavY7J1ED",
"code": "8UWTtFeSff",
"display": "1dyWXCjRrT",
"userSelected": true
}
],
"text": "NoAB2cdOt5"
}
],
"reasonReference": [
{
"reference": "Condition/COyXV2wQqE",
"type": "Condition",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "sZOoHTOAen",
"version": "vhsguZHsaq",
"code": "r_3kdemNuH",
"display": "_ha9Zisg1L",
"userSelected": true
}
],
"text": "Dm5EBrg_tR"
},
"system": "N3mFsdrzoq",
"value": "OFoRNm9Wsz",
"period": {
"start": "2021-04-12T14:34:33.619-05:00",
"end": "2021-04-12T14:34:33.619-05:00"
}
},
"display": "6oX9Ym1uSr"
}
],
"diagnosis": [
{
"condition": {
"reference": "Condition/vSjzXdGc-a",
"type": "Condition",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "JZDP1NZZ97",
"version": "7qR_b7kN3R",
"code": "EjiiV8XyhF",
"display": "FTrWDhm_q5",
"userSelected": true
}
],
"text": "PI3yWMe8Og"
},
"system": "UkbJ20GnfB",
"value": "M4c8GibM09",
"period": {
"start": "2021-04-12T14:34:33.625-05:00",
"end": "2021-04-12T14:34:33.625-05:00"
}
},
"display": "nSUo6wAPpb"
},
"use": {
"coding": [
{
"system": "cWmwoAd2pd",
"version": "0KMeHmMZnW",
"code": "ly8AgjTGep",
"display": "XUpDoo56Aw",
"userSelected": true
}
],
"text": "Tw2zNS7diR"
},
"rank": 1333112032
}
],
"account": [
{
"reference": "Account/4xsh5y5yi4",
"type": "Account",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "QX2c0AHnQ1",
"version": "_toUg977oY",
"code": "83qQ14ro2R",
"display": "7MXmjCb2OF",
"userSelected": true
}
],
"text": "mD2vCj8oe1"
},
"system": "E2tEpewWtV",
"value": "DwuMVhY__c",
"period": {
"start": "2021-04-12T14:34:33.623-05:00",
"end": "2021-04-12T14:34:33.623-05:00"
}
},
"display": "8LhpXyilzq"
}
],
"hospitalization": {
"preAdmissionIdentifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "SmdXWyx3qd",
"version": "gqNFbn7xCk",
"code": "Ivz8Ics02L",
"display": "Wa_Gryjs_W",
"userSelected": true
}
],
"text": "j8gm0KiU4q"
},
"system": "e7wqXPTW3O",
"value": "eOxDqJS5M6",
"period": {
"start": "2021-04-12T14:34:33.614-05:00",
"end": "2021-04-12T14:34:33.614-05:00"
}
},
"origin": {
"reference": "Location/IuDydrFTiW",
"type": "Location",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "sWFW2Rbhii",
"version": "bpJMzRt__k",
"code": "jTa97YsTNO",
"display": "cz7JX2JNy0",
"userSelected": true
}
],
"text": "B8yCMTHNZl"
},
"system": "zjrhIA_qyk",
"value": "gdi38yXHhJ",
"period": {
"start": "2021-04-12T14:34:33.616-05:00",
"end": "2021-04-12T14:34:33.617-05:00"
}
},
"display": "elUkWdBDPL"
},
"admitSource": {
"coding": [
{
"system": "l5QkmIFDdi",
"version": "aviSyIYQVW",
"code": "rKf0heTdSx",
"display": "CIzATkTslI",
"userSelected": true
}
],
"text": "CouVp1O0fW"
},
"reAdmission": {
"coding": [
{
"system": "PuzIdhrit4",
"version": "EtW5D8XeA8",
"code": "nmAeI785CT",
"display": "aSFADtuR8o",
"userSelected": true
}
],
"text": "CAxJIY3FLx"
},
"dietPreference": [
{
"coding": [
{
"system": "U4UKFqeXzT",
"version": "W7Ccuh7AzB",
"code": "8RD96jiWXg",
"display": "LxwLzz5qdN",
"userSelected": true
}
],
"text": "8yeQCGHUb3"
}
],
"specialCourtesy": [
{
"coding": [
{
"system": "l1IBPvXey9",
"version": "jGQe7Dbhql",
"code": "nEkTaEAUmg",
"display": "JdAsUgQmz8",
"userSelected": true
}
],
"text": "FLIdietQfg"
}
],
"specialArrangement": [
{
"coding": [
{
"system": "sFfQeDpmmd",
"version": "q1MzE8etbw",
"code": "9wIlHxj3RK",
"display": "jHB1bEG1kl",
"userSelected": true
}
],
"text": "Y5XBy31PPJ"
}
],
"destination": {
"reference": "Location/bv1zIiiBjx",
"type": "Location",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "rdaF8QKMvX",
"version": "wKwLXmTW60",
"code": "MauIgpW_1c",
"display": "bv4Pr4k4O2",
"userSelected": true
}
],
"text": "Vdvc5ACX_c"
},
"system": "Sm1qC4qWai",
"value": "1crpe2KvT7",
"period": {
"start": "2021-04-12T14:34:33.613-05:00",
"end": "2021-04-12T14:34:33.613-05:00"
}
},
"display": "Fg67RiDwiI"
},
"dischargeDisposition": {
"coding": [
{
"system": "hWxrUqiRvX",
"version": "G0E2I3KNCM",
"code": "0ZUTeE3QkF",
"display": "VZV3xatZ3I",
"userSelected": true
}
],
"text": "RnsvNnyiex"
}
},
"location": [
{
"location": {
"reference": "Location/eP-Szsgz0j",
"type": "Location",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "Cv4qpNFuW3",
"version": "H4_UZepcNu",
"code": "FbIou87XJc",
"display": "Cot0oHXGH4",
"userSelected": true
}
],
"text": "25p5gQjibY"
},
"system": "qOoTEtSl8m",
"value": "C9UR_WKUtl",
"period": {
"start": "2021-04-12T14:34:33.632-05:00",
"end": "2021-04-12T14:34:33.632-05:00"
}
},
"display": "79dCnvPMyX"
},
"status": "planned",
"physicalType": {
"coding": [
{
"system": "6UvZ2rq2Q4",
"version": "8dwM9n0qaB",
"code": "pShnyouRWv",
"display": "NAMpp6ApBO",
"userSelected": true
}
],
"text": "aU9ml4vTLS"
},
"period": {
"start": "2021-04-12T14:34:33.63-05:00",
"end": "2021-04-12T14:34:33.63-05:00"
}
}
],
"serviceProvider": {
"reference": "Organization/cZ4sq78O05",
"type": "Organization",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "ZRgIDHVgtA",
"version": "mI2Pezq0fv",
"code": "Rxj8m6OKe6",
"display": "89Rv_twY37",
"userSelected": true
}
],
"text": "8p8SF1X8BT"
},
"system": "6kEEuCdG7O",
"value": "7kUQKO32e6",
"period": {
"start": "2021-04-12T14:34:33.617-05:00",
"end": "2021-04-12T14:34:33.618-05:00"
}
},
"display": "qFvUFQAWtw"
},
"partOf": {
"reference": "Encounter/C1RcJVPzZm",
"type": "Encounter",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "x1HduJcRnZ",
"version": "AHP1t4VsSF",
"code": "rGNquK6Clx",
"display": "Asip9kql6m",
"userSelected": true
}
],
"text": "lTbyh1c8C_"
},
"system": "up5uSblr1N",
"value": "IayIOCrdu8",
"period": {
"start": "2021-04-12T14:34:33.618-05:00",
"end": "2021-04-12T14:34:33.618-05:00"
}
},
"display": "7BAihrEjYE"
}
}
},
"Encounter_ClassHistory": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"class": {
"$ref": "#/components/schemas/Coding",
"description": "inpatient | outpatient | ambulatory | emergency +."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The time that the episode was in the specified class."
}
},
"required": [
"class",
"period"
]
}
]
},
"Encounter_Diagnosis": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"condition": {
"$ref": "#/components/schemas/Reference",
"description": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure."
},
"use": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)."
},
"rank": {
"type": "integer",
"format": "int32",
"description": "Ranking of the diagnosis (for each role type)."
}
},
"required": [
"condition"
]
}
]
},
"Encounter_Hospitalization": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"preAdmissionIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "Pre–admission identifier."
},
"origin": {
"$ref": "#/components/schemas/Reference",
"description": "The location/organization from which the patient came before admission."
},
"admitSource": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "From where patient was admitted (physician referral, transfer)."
},
"reAdmission": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Whether this hospitalization is a readmission and why if known."
},
"dietPreference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Diet preferences reported by the patient."
}
},
"specialCourtesy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Special courtesies (VIP, board member)."
}
},
"specialArrangement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things."
}
},
"destination": {
"$ref": "#/components/schemas/Reference",
"description": "Location/organization to which the patient is discharged."
},
"dischargeDisposition": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Category or kind of location after discharge."
}
}
}
]
},
"Encounter_Location": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"location": {
"$ref": "#/components/schemas/Reference",
"description": "The location where the encounter takes place."
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time."
},
"physicalType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Time period during which the patient was present at the location."
}
},
"required": [
"location"
]
}
]
},
"Encounter_Participant": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Role of participant in encounter."
}
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The period of time that the specified participant participated in the encounter. These can overlap or be sub–sets of the overall encounter's period."
},
"individual": {
"$ref": "#/components/schemas/Reference",
"description": "Persons involved in the encounter other than the patient."
}
}
}
]
},
"Encounter_StatusHistory": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "planned | arrived | triaged | in–progress | onleave | finished | cancelled +."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The time that the episode was in the specified status."
}
},
"required": [
"status",
"period"
]
}
]
},
"Procedure": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server."
}
},
"instantiatesCanonical": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to a FHIR–defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure."
}
},
"instantiatesUri": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure."
}
},
"basedOn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A reference to a resource that contains details of the request for this procedure."
}
},
"partOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A larger event of which this particular procedure is a component or step."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code specifying the state of the procedure. Generally, this will be the in–progress or completed state."
},
"statusReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Captures the reason for the current state of the procedure."
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\")."
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\")."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "The person, animal or group on which the procedure was performed."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated."
},
"performedDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Estimated or actual date, date–time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured."
},
"performedPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Estimated or actual date, date–time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured."
},
"performedString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Estimated or actual date, date–time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured."
},
"performedAge": {
"$ref": "#/components/schemas/Age",
"description": "Estimated or actual date, date–time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured."
},
"performedRange": {
"$ref": "#/components/schemas/Range",
"description": "Estimated or actual date, date–time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured."
},
"recorder": {
"$ref": "#/components/schemas/Reference",
"description": "Individual who recorded the record and takes responsibility for its content."
},
"asserter": {
"$ref": "#/components/schemas/Reference",
"description": "Individual who is making the procedure statement."
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Procedure_Performer",
"description": "Limited to \"real\" people rather than equipment."
}
},
"location": {
"$ref": "#/components/schemas/Reference",
"description": "The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant."
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The justification of why the procedure was performed."
}
},
"bodySite": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Detailed and structured anatomical location information. Multiple locations are allowed – e.g. multiple punch biopsies of a lesion."
}
},
"outcome": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The outcome of the procedure – did it resolve the reasons for the procedure being performed?"
},
"report": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "This could be a histology result, pathology report, surgical report, etc."
}
},
"complication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Any complications that occurred during the procedure, or in the immediate post–performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues."
}
},
"complicationDetail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Any complications that occurred during the procedure, or in the immediate post–performance period."
}
},
"followUp": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "If the procedure required specific follow up – e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Any other notes and comments about the procedure."
}
},
"focalDevice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Procedure_FocalDevice",
"description": "A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound–vac, etc.) as a focal portion of the Procedure."
}
},
"usedReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies medications, devices and any other substance used as part of the procedure."
}
},
"usedCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies coded items that were used as part of the procedure."
}
}
},
"required": [
"status",
"subject"
]
}
],
"example": {
"resourceType": "Procedure",
"meta": {
"versionId": "W3scD5wETD",
"lastUpdated": "2021-04-12T14:34:28.949-05:00",
"source": "o36ORkmjSR",
"profile": [
"F8snmHZ53A"
],
"security": [
{
"system": "vl5WOPAtpT",
"version": "3u6tGyoD5B",
"code": "pK_miaxxWx",
"display": "EAt5k0FAPc",
"userSelected": true
}
],
"tag": [
{
"system": "gzbxtfqeWt",
"version": "zSLGMEFwxa",
"code": "cEuByqKdkR",
"display": "aXkaNPLapn",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "yIW7AXI5Ip",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "YNbcaXHKRb",
"version": "4SiKY51Wpv",
"code": "DP68nHUDT6",
"display": "Rk3xjJyWYy",
"userSelected": true
}
],
"text": "EiMD4UhsbG"
},
"system": "bbcUMoMvsn",
"value": "WUV5APGXKV",
"period": {
"start": "2021-04-12T14:34:28.935-05:00",
"end": "2021-04-12T14:34:28.935-05:00"
}
}
],
"instantiatesCanonical": [
"EzzyNTFMrc"
],
"instantiatesUri": [
"AeBiPVCi3l"
],
"basedOn": [
{
"reference": "CarePlan/Afhi5E4cUc",
"type": "CarePlan",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "BlTTdJnKhk",
"version": "Uj6XMVhDnv",
"code": "qdirTkaZ3s",
"display": "ArzX6UOBze",
"userSelected": true
}
],
"text": "PQ3hfdAhAG"
},
"system": "s7PBXpkSwg",
"value": "fp2GClb_2L",
"period": {
"start": "2021-04-12T14:34:28.933-05:00",
"end": "2021-04-12T14:34:28.933-05:00"
}
},
"display": "P2cGCb7BUn"
}
],
"partOf": [
{
"reference": "Procedure/Wf1ZcbACWK",
"type": "Procedure",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "OYm1M5pZSY",
"version": "arYWx8JkBR",
"code": "QVrBGRFdiA",
"display": "Cp3BZzC05b",
"userSelected": true
}
],
"text": "1iEB2kqrQH"
},
"system": "m9de15QnNM",
"value": "p0lDpmDoPY",
"period": {
"start": "2021-04-12T14:34:28.929-05:00",
"end": "2021-04-12T14:34:28.929-05:00"
}
},
"display": "tNdKBCRL96"
}
],
"status": "in-progress",
"statusReason": {
"coding": [
{
"system": "3Z0qYRbGzn",
"version": "3IZ_f8wRJ3",
"code": "XQsZ_PCxUH",
"display": "KfheNfAski",
"userSelected": true
}
],
"text": "AWdyimUJ2h"
},
"category": {
"coding": [
{
"system": "zRF7f1FG2G",
"version": "daHAkjwEYD",
"code": "9XBTtXoh8y",
"display": "GxloL4SnDA",
"userSelected": true
}
],
"text": "qx3SGIzc8e"
},
"code": {
"coding": [
{
"system": "SLBP38BsL0",
"version": "tZ3kSk0ArZ",
"code": "M0zQJuXPCE",
"display": "mzzeIEZuQV",
"userSelected": true
}
],
"text": "PvPHlt9vPy"
},
"subject": {
"reference": "Patient/Nb3FPJiXFV",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "k0cM_OF3QX",
"version": "4irSyqVS5R",
"code": "WbxwrzWnF7",
"display": "0D0EIxqIMT",
"userSelected": true
}
],
"text": "DZuDEXImgp"
},
"system": "XbxKs1fneU",
"value": "C7zkpe59Yk",
"period": {
"start": "2021-04-12T14:34:28.945-05:00",
"end": "2021-04-12T14:34:28.945-05:00"
}
},
"display": "tNelZRIQ_J"
},
"encounter": {
"reference": "Encounter/paG1n-i93T",
"type": "Encounter",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "1xZ4wV_jgd",
"version": "gab6bJfTSw",
"code": "wTj_7VVCdu",
"display": "wDbDzxlhHr",
"userSelected": true
}
],
"text": "9_T_LaXldq"
},
"system": "3ziOS5_LMD",
"value": "Ty6yfQSKuD",
"period": {
"start": "2021-04-12T14:34:28.947-05:00",
"end": "2021-04-12T14:34:28.947-05:00"
}
},
"display": "1iAAwsLONz"
},
"performedDateTime": "2021-04-12T14:34:28.95-05:00",
"recorder": {
"reference": "Patient/SvT0eOazwj",
"type": "Patient",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "7UkyUnXp8l",
"version": "VX_5fiQaZw",
"code": "La5fJDWCOH",
"display": "xfMC8Qn5nA",
"userSelected": true
}
],
"text": "aBSBRrHfCr"
},
"system": "asBw9fs4qC",
"value": "QaLAf3FqWd",
"period": {
"start": "2021-04-12T14:34:28.93-05:00",
"end": "2021-04-12T14:34:28.931-05:00"
}
},
"display": "sKRwWTGDrq"
},
"asserter": {
"reference": "Patient/K7efldxKsH",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "fU3dSq0HCm",
"version": "fkxxyr2_lW",
"code": "8F9_QvKb_E",
"display": "__2o0twCbl",
"userSelected": true
}
],
"text": "8T_qwTipo5"
},
"system": "v0oixF1Jrw",
"value": "wl5lqhYfCv",
"period": {
"start": "2021-04-12T14:34:28.944-05:00",
"end": "2021-04-12T14:34:28.944-05:00"
}
},
"display": "q6ZKbucL0m"
},
"performer": [
{
"function": {
"coding": [
{
"system": "FOzCFvF7l_",
"version": "WVyb2k4RFO",
"code": "ofC25Bg9Q4",
"display": "csE9nQebxJ",
"userSelected": true
}
],
"text": "fyot0KC5ar"
},
"actor": {
"reference": "Practitioner/Ot8yWcBmKE",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "_O2OEZ11iG",
"version": "gYfej4Pjbv",
"code": "ovwAOGCZHf",
"display": "vN3YIXWQcq",
"userSelected": true
}
],
"text": "_E3Uti5Jx_"
},
"system": "droyVIdXxh",
"value": "VODjZp_NRL",
"period": {
"start": "2021-04-12T14:34:28.94-05:00",
"end": "2021-04-12T14:34:28.94-05:00"
}
},
"display": "KbArKrMJJH"
},
"onBehalfOf": {
"reference": "Organization/c1Dzxbjhio",
"type": "Organization",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "1ULctqY6LV",
"version": "E2oxXZ_3vq",
"code": "j8Q0wQqbrW",
"display": "7Fu4Flff4L",
"userSelected": true
}
],
"text": "sIIYM0zT9c"
},
"system": "Zx0fpmWjGU",
"value": "wHDnMNXEgZ",
"period": {
"start": "2021-04-12T14:34:28.938-05:00",
"end": "2021-04-12T14:34:28.939-05:00"
}
},
"display": "fsEsdcJWYV"
}
}
],
"location": {
"reference": "Location/DK1CaGQ3vH",
"type": "Location",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "KnTUXHL92T",
"version": "OxZwNAghvf",
"code": "qtwV5mB2IS",
"display": "GOuUSJ89jC",
"userSelected": true
}
],
"text": "xRA93_NNJi"
},
"system": "j1ns_Kt6HB",
"value": "Sr1EJHx_Hl",
"period": {
"start": "2021-04-12T14:34:28.948-05:00",
"end": "2021-04-12T14:34:28.948-05:00"
}
},
"display": "vgvUOsrru0"
},
"reasonCode": [
{
"coding": [
{
"system": "8v7OetfL08",
"version": "DRMBEOv_u8",
"code": "C2bk9qHCr8",
"display": "wa76BjcK4K",
"userSelected": true
}
],
"text": "yc6axaKyBZ"
}
],
"reasonReference": [
{
"reference": "Condition/hqOBkCoklS",
"type": "Condition",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "ZNbEC93hXJ",
"version": "y8j8jbCN5B",
"code": "k2kjvOyrgT",
"display": "um9M5ZtM_b",
"userSelected": true
}
],
"text": "AHX8_snCUA"
},
"system": "V3YuGUfQYq",
"value": "BjTrYU1XTk",
"period": {
"start": "2021-04-12T14:34:28.932-05:00",
"end": "2021-04-12T14:34:28.932-05:00"
}
},
"display": "mzLciPvphk"
}
],
"bodySite": [
{
"coding": [
{
"system": "3xaSiUnWZ8",
"version": "A_01CCao4W",
"code": "woLhC8dijr",
"display": "WJpMAwCTQW",
"userSelected": true
}
],
"text": "nBOQCkE1VR"
}
],
"outcome": {
"coding": [
{
"system": "doj3IJabka",
"version": "P_mGySzsxh",
"code": "ZK81S6pIdU",
"display": "driW_9NCS0",
"userSelected": true
}
],
"text": "C10QsP1Dwv"
},
"report": [
{
"reference": "DiagnosticReport/gGVD-Uxbfd",
"type": "DiagnosticReport",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "vCUoukCGwe",
"version": "v2a02X3igl",
"code": "bQY2FjkM2V",
"display": "IO4QpGjbry",
"userSelected": true
}
],
"text": "Hq0TlYMvuq"
},
"system": "XFkHEy3PEe",
"value": "pNsHv5rljB",
"period": {
"start": "2021-04-12T14:34:28.936-05:00",
"end": "2021-04-12T14:34:28.936-05:00"
}
},
"display": "qdvQ0zq9Rv"
}
],
"complication": [
{
"coding": [
{
"system": "YrR6Tv9oIa",
"version": "nMk4IMAkii",
"code": "NY4ZQXhwPw",
"display": "Lv4Gwdb62G",
"userSelected": true
}
],
"text": "mgRtbts427"
}
],
"complicationDetail": [
{
"reference": "Condition/r4buqnV49Y",
"type": "Condition",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "Kj5ja46Q5D",
"version": "AvNONkg3zh",
"code": "EevoELctks",
"display": "Y2Vx9CN4EF",
"userSelected": true
}
],
"text": "4ZH6yRiCKi"
},
"system": "IeTgVvfrUE",
"value": "c3Gs_oMnb0",
"period": {
"start": "2021-04-12T14:34:28.951-05:00",
"end": "2021-04-12T14:34:28.951-05:00"
}
},
"display": "w3_ycFmZXx"
}
],
"followUp": [
{
"coding": [
{
"system": "g7l5lkERhE",
"version": "CV3c6aMAdz",
"code": "7_qsE2PcpU",
"display": "G2qTXCZAkM",
"userSelected": true
}
],
"text": "jRspOfSiUL"
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/nQ8C061DpO",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "KVu7kvH4ld",
"version": "uDgMpHjWd_",
"code": "SE0umBEAMR",
"display": "7E5MFKSbBe",
"userSelected": true
}
],
"text": "QknWw890T9"
},
"system": "IQVxKkd2m0",
"value": "0l3Tx8b1ge",
"period": {
"start": "2021-04-12T14:34:28.942-05:00",
"end": "2021-04-12T14:34:28.942-05:00"
}
},
"display": "rXHwCr53m3"
},
"time": "2021-04-12T14:34:28.943-05:00",
"text": "WeC6C3_wOi"
}
],
"focalDevice": [
{
"action": {
"coding": [
{
"system": "BaJZyIDEyO",
"version": "NW_8ZTflZs",
"code": "46ywbNkIl3",
"display": "i0_afv61Ux",
"userSelected": true
}
],
"text": "v5oLw9jgYH"
},
"manipulated": {
"reference": "Device/pGBoLMsh63",
"type": "Device",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "zktflHcWoG",
"version": "MlH_ewO60A",
"code": "TjBB6nGLSy",
"display": "GqqPb2bBus",
"userSelected": true
}
],
"text": "LJWQMWnKsA"
},
"system": "9UmzS_ro13",
"value": "5Z0eZAhoIE",
"period": {
"start": "2021-04-12T14:34:28.953-05:00",
"end": "2021-04-12T14:34:28.953-05:00"
}
},
"display": "3CsYe7NTrZ"
}
}
],
"usedReference": [
{
"reference": "Device/NDT4Kjt8s6",
"type": "Device",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "zwe8_fBtnJ",
"version": "rvIvTzRQj8",
"code": "PktgFS2iCT",
"display": "FZ0OFKqC8z",
"userSelected": true
}
],
"text": "xvYhWi8oPk"
},
"system": "g9_M0NXMTz",
"value": "1sRz_06iqT",
"period": {
"start": "2021-04-12T14:34:28.953-05:00",
"end": "2021-04-12T14:34:28.954-05:00"
}
},
"display": "Sd1hKOv7VF"
}
],
"usedCode": [
{
"coding": [
{
"system": "fyRA1kwRxl",
"version": "fX538zr_XZ",
"code": "hcEtZ3LCqi",
"display": "Lct79PBEeR",
"userSelected": true
}
],
"text": "BtpqVupy9d"
}
]
}
},
"Procedure_FocalDevice": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"action": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The kind of change that happened to the device during the procedure."
},
"manipulated": {
"$ref": "#/components/schemas/Reference",
"description": "The device that was manipulated (changed) during the procedure."
}
},
"required": [
"manipulated"
]
}
]
},
"Procedure_Performer": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"function": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist."
},
"actor": {
"$ref": "#/components/schemas/Reference",
"description": "The practitioner who was involved in the procedure."
},
"onBehalfOf": {
"$ref": "#/components/schemas/Reference",
"description": "The organization the device or practitioner was acting on behalf of."
}
},
"required": [
"actor"
]
}
]
},
"MedicationRequest": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code specifying the current state of the order. Generally, this will be active or completed state."
},
"statusReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Captures the reason for the current state of the MedicationRequest."
},
"intent": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Whether the request is a proposal, plan, or an original order."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient))."
}
},
"priority": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates how quickly the Medication Request should be addressed with respect to other requests."
},
"doNotPerform": {
"type": "boolean",
"description": "If true indicates that the provider is asking for the medication request not to occur."
},
"reportedBoolean": {
"type": "boolean",
"description": "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source–of–truth record. It may also indicate the source of the report."
},
"reportedReference": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source–of–truth record. It may also indicate the source of the report."
},
"medicationCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications."
},
"medicationReference": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "A link to a resource representing the person or set of individuals to whom the medication will be given."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The Encounter during which this [x] was created or to which the creation of this record is tightly associated."
},
"supportingInformation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Include additional information (for example, patient height and weight) that supports the ordering of the medication."
}
},
"authoredOn": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date (and perhaps time) when the prescription was initially written or authored on."
},
"requester": {
"$ref": "#/components/schemas/Reference",
"description": "The individual, organization, or device that initiated the request and has responsibility for its activation."
},
"performer": {
"$ref": "#/components/schemas/Reference",
"description": "The specified desired performer of the medication treatment (e.g. the performer of the medication administration)."
},
"performerType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the type of performer of the administration of the medication."
},
"recorder": {
"$ref": "#/components/schemas/Reference",
"description": "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order."
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The reason or the indication for ordering or not ordering the medication."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Condition or observation that supports why the medication was ordered."
}
},
"instantiatesCanonical": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest."
}
},
"instantiatesUri": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest."
}
},
"basedOn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A plan or request that is fulfilled in whole or in part by this medication request."
}
},
"groupIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription."
},
"courseOfTherapyType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The description of the overall patte3rn of the administration of the medication to the patient."
},
"insurance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Insurance plans, coverage extensions, pre–authorizations and/or pre–determinations that may be required for delivering the requested service."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Extra information about the prescription that could not be conveyed by the other attributes."
}
},
"dosageInstruction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dosage",
"description": "Indicates how the medication is to be used by the patient."
}
},
"dispenseRequest": {
"$ref": "#/components/schemas/MedicationRequest_DispenseRequest",
"description": "Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department."
},
"substitution": {
"$ref": "#/components/schemas/MedicationRequest_Substitution",
"description": "Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done."
},
"priorPrescription": {
"$ref": "#/components/schemas/Reference",
"description": "A link to a resource representing an earlier order related order or prescription."
},
"detectedIssue": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug–drug interaction, duplicate therapy, dosage alert etc."
}
},
"eventHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource."
}
}
},
"required": [
"status",
"intent",
"subject"
]
}
],
"example": {
"resourceType": "MedicationRequest",
"meta": {
"versionId": "KtMriEzQrQ",
"lastUpdated": "2021-04-12T14:34:35.975-05:00",
"source": "jSvOwx5MOe",
"profile": [
"DUcagJf2yX"
],
"security": [
{
"system": "VOMgsseLM0",
"version": "YtsS7ghoBZ",
"code": "Q2Ch9Uum4W",
"display": "70diKJPFbX",
"userSelected": true
}
],
"tag": [
{
"system": "30eJF7mmem",
"version": "pEuFWDuBby",
"code": "k69KgS8sdY",
"display": "pe19HSDFaY",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "Scy8VeQqf3",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "temp",
"type": {
"coding": [
{
"system": "FVaEVtSP8z",
"version": "yPgJV4oq9p",
"code": "S3jLxMfioK",
"display": "KkBd3jD3aN",
"userSelected": true
}
],
"text": "mKaXRDYONo"
},
"system": "m0RMj3KNLY",
"value": "cu7_9uRCqe",
"period": {
"start": "2021-04-12T14:34:35.967-05:00",
"end": "2021-04-12T14:34:35.967-05:00"
}
}
],
"status": "entered-in-error",
"statusReason": {
"coding": [
{
"system": "WCB7MQO1h_",
"version": "o8hrMPA3ml",
"code": "TunW81SvVX",
"display": "tkZ7A60qnN",
"userSelected": true
}
],
"text": "YpxtMSt9I9"
},
"intent": "filler-order",
"category": [
{
"coding": [
{
"system": "oOgWDne0A9",
"version": "QH5q2c2w_B",
"code": "pzhFXQcok2",
"display": "1QgsSgbFRO",
"userSelected": true
}
],
"text": "ZSHgemyzBC"
}
],
"priority": "asap",
"doNotPerform": true,
"reportedBoolean": true,
"medicationCodeableConcept": {
"coding": [
{
"system": "1a2xCYrEeq",
"version": "ecL36zdBpV",
"code": "QRdUXuDhe9",
"display": "9_7nOCoJ4G",
"userSelected": true
}
],
"text": "3N0d38PixT"
},
"subject": {
"reference": "Patient/5GIYbLEkhM",
"type": "Patient",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "LPVhOK39cD",
"version": "AolvDgJhZA",
"code": "ugHqP9yQUP",
"display": "Ky3jYWShwZ",
"userSelected": true
}
],
"text": "PCel6T6OwY"
},
"system": "njpBzxFeoC",
"value": "XoVMII86qU",
"period": {
"start": "2021-04-12T14:34:35.972-05:00",
"end": "2021-04-12T14:34:35.972-05:00"
}
},
"display": "pE63CAAgph"
},
"encounter": {
"reference": "Encounter/mfTStpH3sU",
"type": "Encounter",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "hXkY3hdxRo",
"version": "W2cnNu8r63",
"code": "e38bNM3axI",
"display": "15dQKYaAVK",
"userSelected": true
}
],
"text": "2XEeSK7dvm"
},
"system": "RJX0XdTnoC",
"value": "0lb3LwTgQo",
"period": {
"start": "2021-04-12T14:34:35.972-05:00",
"end": "2021-04-12T14:34:35.973-05:00"
}
},
"display": "DzFnnhC8L5"
},
"supportingInformation": [
{
"reference": "Basic/omN6xGkCVU",
"type": "Basic",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "Anb5HmseKn",
"version": "5pzCkSVIO8",
"code": "otKB0EJtfV",
"display": "3SnLgHJU76",
"userSelected": true
}
],
"text": "_5rL9Up1AJ"
},
"system": "NXEvh_FWDr",
"value": "mX1W8EqBaA",
"period": {
"start": "2021-04-12T14:34:35.954-05:00",
"end": "2021-04-12T14:34:35.954-05:00"
}
},
"display": "KC05fGYqDM"
}
],
"authoredOn": "2021-04-12T14:34:35.963-05:00",
"requester": {
"reference": "Practitioner/FINUqaZUhR",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "zqYoyNIzHS",
"version": "4cCLDA7BR_",
"code": "wn04qhzJ38",
"display": "LzxNs3p30t",
"userSelected": true
}
],
"text": "Ms1EuhDIjg"
},
"system": "dOzCrnjh0p",
"value": "ee6c5ICHGd",
"period": {
"start": "2021-04-12T14:34:35.969-05:00",
"end": "2021-04-12T14:34:35.969-05:00"
}
},
"display": "TerK4NMy4H"
},
"performer": {
"reference": "Practitioner/zadPOPWGqE",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "KNtBMJ5idr",
"version": "6ZbvZnaVmA",
"code": "u0PCxYQIX2",
"display": "heZwIFXiip",
"userSelected": true
}
],
"text": "BNXSDTO_Yk"
},
"system": "xtC7VOfNyD",
"value": "mjr9h7iRMF",
"period": {
"start": "2021-04-12T14:34:35.969-05:00",
"end": "2021-04-12T14:34:35.969-05:00"
}
},
"display": "NKPBZvBx_8"
},
"performerType": {
"coding": [
{
"system": "TLhXfWIMgv",
"version": "uUAB8r_1Jf",
"code": "a1voOJ9QCc",
"display": "EQPqlxQxOl",
"userSelected": true
}
],
"text": "an_lMeTNFG"
},
"recorder": {
"reference": "Practitioner/J1HvPJsTKr",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "vvxw8ayNKs",
"version": "6NLsGyrOKV",
"code": "o8QiH1QTux",
"display": "r6otKeodpD",
"userSelected": true
}
],
"text": "Nnr9YvNPLe"
},
"system": "MqlJRtruD3",
"value": "egvUQ8XQ0F",
"period": {
"start": "2021-04-12T14:34:35.952-05:00",
"end": "2021-04-12T14:34:35.952-05:00"
}
},
"display": "jPlP_YB6jL"
},
"reasonCode": [
{
"coding": [
{
"system": "ay16EheZKE",
"version": "dI2lhtRS7L",
"code": "RWq3FvvqyA",
"display": "qsP5vHu8gH",
"userSelected": true
}
],
"text": "UXxgJoYv5g"
}
],
"reasonReference": [
{
"reference": "Condition/y67ZsgGSHd",
"type": "Condition",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "WapbHNAtpF",
"version": "CVa_c1Yj3G",
"code": "QKx8gckBTz",
"display": "SQkkTsYJYy",
"userSelected": true
}
],
"text": "dCeLDC44Vm"
},
"system": "NpJpL77CGW",
"value": "Z0tKst3o1w",
"period": {
"start": "2021-04-12T14:34:35.953-05:00",
"end": "2021-04-12T14:34:35.953-05:00"
}
},
"display": "OGKSYLwEvP"
}
],
"instantiatesCanonical": [
"Vk9mwo8Mt4"
],
"instantiatesUri": [
"cdtB1KLgz8"
],
"basedOn": [
{
"reference": "CarePlan/bxI14WkSWN",
"type": "CarePlan",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "gVG67ghsfD",
"version": "756RhIo7Yt",
"code": "flJhK8HELm",
"display": "O4FoLMzJFG",
"userSelected": true
}
],
"text": "G1w46TTrPc"
},
"system": "I2difWXw43",
"value": "Tby74vAm5E",
"period": {
"start": "2021-04-12T14:34:35.955-05:00",
"end": "2021-04-12T14:34:35.955-05:00"
}
},
"display": "8sfrk_IiMd"
}
],
"groupIdentifier": {
"use": "official",
"type": {
"coding": [
{
"system": "zw4uwP32DT",
"version": "B5etBdP0XA",
"code": "nDQNjC85No",
"display": "1X_sADZ30k",
"userSelected": true
}
],
"text": "n90c_5iOvs"
},
"system": "KYNJrxrmyy",
"value": "anjuEN_eon",
"period": {
"start": "2021-04-12T14:34:35.97-05:00",
"end": "2021-04-12T14:34:35.97-05:00"
}
},
"courseOfTherapyType": {
"coding": [
{
"system": "U36kB5b4Zv",
"version": "EdRUVJVFgO",
"code": "187l_dp9gV",
"display": "iseKabklCQ",
"userSelected": true
}
],
"text": "ZHcyWg0t6S"
},
"insurance": [
{
"reference": "Coverage/2IjZ2oVzYi",
"type": "Coverage",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "c5GHCHGZLR",
"version": "rcUspHxb1n",
"code": "U9Swc0HhfN",
"display": "L05M4CE37j",
"userSelected": true
}
],
"text": "9NMFiwLFKa"
},
"system": "MHHqOMLPe0",
"value": "33wjrMvRum",
"period": {
"start": "2021-04-12T14:34:35.971-05:00",
"end": "2021-04-12T14:34:35.971-05:00"
}
},
"display": "0sxDMJW7yO"
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/VgiOF6Vnri",
"type": "Practitioner",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "IjEBDS4BKD",
"version": "0OmU0UD6OT",
"code": "mllA172SCd",
"display": "rLsEKyuB6g",
"userSelected": true
}
],
"text": "EgkQIDIV7i"
},
"system": "R7tv6Pq2Gz",
"value": "sZYtlgKTUH",
"period": {
"start": "2021-04-12T14:34:35.97-05:00",
"end": "2021-04-12T14:34:35.97-05:00"
}
},
"display": "bz85QREybR"
},
"time": "2021-04-12T14:34:35.971-05:00",
"text": "80qOyQVAkd"
}
],
"dosageInstruction": [
{
"sequence": 1310054256,
"text": "oAu22XSD1C",
"additionalInstruction": [
{
"coding": [
{
"system": "SqJ77LKFBz",
"version": "_1lsaP1Z6h",
"code": "y1zh0uDNF3",
"display": "qJW0ziHWKo",
"userSelected": true
}
],
"text": "vUAJErk46u"
}
],
"patientInstruction": "6hgMHMbZ2x",
"timing": {
"event": [
"2021-04-12T14:34:35.957-05:00"
],
"repeat": {
"boundsDuration": {
"value": 215342601308,
"comparator": "<",
"unit": "8tszXP7aNy",
"system": "http://unitsofmeasure.org",
"code": "h"
},
"count": 1560689479,
"countMax": 100579243,
"duration": 443844399398,
"durationMax": 541257060415,
"durationUnit": "s",
"frequency": 1130927046,
"frequencyMax": 1867773133,
"period": 538233543494,
"periodMax": 396065784895,
"periodUnit": "s",
"dayOfWeek": [
"fri"
],
"when": [
"NIGHT"
]
},
"code": {
"coding": [
{
"system": "yZPSnYrcan",
"version": "sjIWr4m3Px",
"code": "SKC6ETKgRD",
"display": "wCT4_gggRJ",
"userSelected": true
}
],
"text": "K6utyrUzkr"
}
},
"asNeededBoolean": true,
"site": {
"coding": [
{
"system": "jEOS1DU0AX",
"version": "2jTwhDyZ5n",
"code": "DIyg1CCehI",
"display": "3j9FWES3Gy",
"userSelected": true
}
],
"text": "X2aRuDFbzd"
},
"route": {
"coding": [
{
"system": "4QPjIoRcAE",
"version": "2Lbt3flf9s",
"code": "m2rRxHHfVd",
"display": "2HninMep0X",
"userSelected": true
}
],
"text": "bKu2DYqgVB"
},
"method": {
"coding": [
{
"system": "9Oje0OAG3i",
"version": "U1_0N70SZ1",
"code": "3dL_MpE5Df",
"display": "TON5dM4zwD",
"userSelected": true
}
],
"text": "x8P7F6DW7J"
},
"doseAndRate": [
{
"type": {
"coding": [
{
"system": "9tA23wZ3iI",
"version": "2ybjoP1jFd",
"code": "imj2icU4Rh",
"display": "tREUrKKTWR",
"userSelected": true
}
],
"text": "yxKEE9G05C"
},
"doseRange": {
"low": {
"value": 86995327267,
"unit": "91LHsvd6Yz",
"system": "mBuxtINqng",
"code": "pYKViOxkaE"
}
},
"rateRatio": {
"numerator": {
"value": 48051084102,
"comparator": ">=",
"unit": "CglMCeobuS",
"system": "wkwPkubBP5",
"code": "Uio_4Ah9JA"
},
"denominator": {
"value": 382576099650,
"comparator": ">=",
"unit": "l9pHyKMukG",
"system": "xnWEMCILVR",
"code": "2d5KGO61yt"
}
}
}
],
"maxDosePerPeriod": {
"numerator": {
"value": 447180991049,
"comparator": ">=",
"unit": "yNSaaIDnf4",
"system": "ynquDU6IVr",
"code": "3XdrWUD0Mx"
},
"denominator": {
"value": 198128576093,
"comparator": "<",
"unit": "KhMMyzXOhO",
"system": "_t1Uz7fera",
"code": "gunsaCWus3"
}
},
"maxDosePerAdministration": {
"value": 73941009665,
"unit": "QHvRknLIt4",
"system": "weuI3LV74D",
"code": "ge1LPfAHVu"
},
"maxDosePerLifetime": {
"value": 23374018584,
"unit": "_XYdNL2_RG",
"system": "m8FycimK6D",
"code": "wGAx2FLB9D"
}
}
],
"dispenseRequest": {
"initialFill": {
"quantity": {
"value": 52835860274,
"unit": "huV7spOEqZ",
"system": "_nGIxn63K_",
"code": "Xl5dPP_Gse"
},
"duration": {
"value": 408831791225,
"comparator": ">=",
"unit": "n6vbT0Nt81",
"system": "http://unitsofmeasure.org",
"code": "h"
}
},
"dispenseInterval": {
"value": 435020653874,
"comparator": "<",
"unit": "GPiuFpo8cm",
"system": "http://unitsofmeasure.org",
"code": "h"
},
"validityPeriod": {
"start": "2021-04-12T14:34:35.965-05:00",
"end": "2021-04-12T14:34:35.965-05:00"
},
"numberOfRepeatsAllowed": 947168474,
"quantity": {
"value": 313685800992,
"unit": "uSYzv45XKl",
"system": "i8gml1IDEv",
"code": "T3ekwxtrDB"
},
"expectedSupplyDuration": {
"value": 47822022202,
"comparator": ">=",
"unit": "AO6eBCJLUw",
"system": "http://unitsofmeasure.org",
"code": "h"
},
"performer": {
"reference": "Organization/c2OPsN16cH",
"type": "Organization",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "zHOV3BK1am",
"version": "4R8S8FPTd1",
"code": "toMwOzVQIv",
"display": "aFteBCMcqU",
"userSelected": true
}
],
"text": "yrtAVajAtz"
},
"system": "f1XPnNUZyh",
"value": "fiJuf6tpcy",
"period": {
"start": "2021-04-12T14:34:35.964-05:00",
"end": "2021-04-12T14:34:35.964-05:00"
}
},
"display": "NTPFZvTBOV"
}
},
"substitution": {
"allowedBoolean": true,
"reason": {
"coding": [
{
"system": "30NRgsOQCZ",
"version": "_25SB3E7Zy",
"code": "lvZNEy9Bsf",
"display": "MR9tCNoc0Z",
"userSelected": true
}
],
"text": "NnXPdmV9o1"
}
},
"priorPrescription": {
"reference": "MedicationRequest/GNJXR3iIrD",
"type": "MedicationRequest",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "2fcH3jhZ2Z",
"version": "xc6flqkSR7",
"code": "2orXPnbhg_",
"display": "JE_YO_iwh5",
"userSelected": true
}
],
"text": "E_y71iJY0r"
},
"system": "L_mSlzhnYr",
"value": "JMAg7HC8QX",
"period": {
"start": "2021-04-12T14:34:35.966-05:00",
"end": "2021-04-12T14:34:35.967-05:00"
}
},
"display": "H3woZHZ_67"
},
"detectedIssue": [
{
"reference": "DetectedIssue/yRKBLj5WIQ",
"type": "DetectedIssue",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "vJqQMdFghx",
"version": "C4R09m7wMs",
"code": "_boGmWrJjI",
"display": "U3LakAQ830",
"userSelected": true
}
],
"text": "JQAZ5KUZZI"
},
"system": "RZ8vHvTr9G",
"value": "rpU2no4aXF",
"period": {
"start": "2021-04-12T14:34:35.968-05:00",
"end": "2021-04-12T14:34:35.968-05:00"
}
},
"display": "1Dciwwrqe9"
}
],
"eventHistory": [
{
"reference": "Provenance/hvnxttvItF",
"type": "Provenance",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "cqNBNrdZH1",
"version": "8IsUSu2H0a",
"code": "sc2V7AFKTs",
"display": "PB9HyYqSmN",
"userSelected": true
}
],
"text": "d_NOx2YYAH"
},
"system": "JvkCLNxdzH",
"value": "uU9NoJG4kU",
"period": {
"start": "2021-04-12T14:34:35.976-05:00",
"end": "2021-04-12T14:34:35.976-05:00"
}
},
"display": "oxhd2S4qyL"
}
]
}
},
"MedicationRequest_DispenseRequest": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"initialFill": {
"$ref": "#/components/schemas/MedicationRequest_DispenseRequest_InitialFill",
"description": "Indicates the quantity or duration for the first dispense of the medication."
},
"dispenseInterval": {
"$ref": "#/components/schemas/Duration",
"description": "The minimum period of time that must occur between dispenses of the medication."
},
"validityPeriod": {
"$ref": "#/components/schemas/Period",
"description": "This indicates the validity period of a prescription (stale dating the Prescription)."
},
"numberOfRepeatsAllowed": {
"type": "integer",
"format": "int32",
"description": "An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense."
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The amount that is to be dispensed for one fill."
},
"expectedSupplyDuration": {
"$ref": "#/components/schemas/Duration",
"description": "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last."
},
"performer": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates the intended dispensing Organization specified by the prescriber."
}
}
}
]
},
"MedicationRequest_DispenseRequest_InitialFill": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The amount or quantity to provide as part of the first dispense."
},
"duration": {
"$ref": "#/components/schemas/Duration",
"description": "The length of time that the first dispense is expected to last."
}
}
}
]
},
"MedicationRequest_Substitution": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"allowedBoolean": {
"type": "boolean",
"description": "True if the prescriber allows a different drug to be dispensed from what was prescribed."
},
"allowedCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "True if the prescriber allows a different drug to be dispensed from what was prescribed."
},
"reason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the reason for the substitution, or why substitution must or must not be performed."
}
}
}
]
},
"ParameterDefinition": {
"allOf": [
{
"$ref": "#/components/schemas/Element"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The name of the parameter used to allow access to the value of the parameter in evaluation contexts."
},
"use": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Whether the parameter is input or output for the module."
},
"min": {
"type": "integer",
"format": "int32",
"description": "The minimum number of times this parameter SHALL appear in the request or response."
},
"max": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The maximum number of times this element is permitted to appear in the request or response."
},
"documentation": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A brief discussion of what the parameter is for and how it is used by the module."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The type of the parameter."
},
"profile": {
"type": "string",
"pattern": "\\S*",
"description": "If specified, this indicates a profile that the input data must conform to, or that the output data will conform to."
}
},
"required": [
"use",
"type"
]
}
]
},
"Dosage": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32",
"description": "Indicates the order in which the dosage instructions should be applied or interpreted."
},
"text": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Free text dosage instructions e.g. SIG."
},
"additionalInstruction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Supplemental instructions to the patient on how to take the medication (e.g. \"with meals\" or\"take half to one hour before food\") or warnings for the patient about the medication (e.g. \"may cause drowsiness\" or \"avoid exposure of skin to direct sunlight or sunlamps\")."
}
},
"patientInstruction": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Instructions in terms that are understood by the patient or consumer."
},
"timing": {
"$ref": "#/components/schemas/Timing",
"description": "When medication should be administered."
},
"asNeededBoolean": {
"type": "boolean",
"description": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept)."
},
"asNeededCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept)."
},
"site": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Body site to administer to."
},
"route": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "How drug should enter body."
},
"method": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Technique for administering medication."
},
"doseAndRate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dosage_DoseAndRate",
"description": "The amount of medication administered."
}
},
"maxDosePerPeriod": {
"$ref": "#/components/schemas/Ratio",
"description": "Upper limit on medication per unit of time."
},
"maxDosePerAdministration": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "Upper limit on medication per administration."
},
"maxDosePerLifetime": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "Upper limit on medication per lifetime of the patient."
}
}
}
]
},
"Dosage_DoseAndRate": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The kind of dose or rate specified, for example, ordered or calculated."
},
"doseRange": {
"$ref": "#/components/schemas/Range",
"description": "Amount of medication per dose."
},
"doseQuantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "Amount of medication per dose."
},
"rateRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "Amount of medication per unit of time."
},
"rateRange": {
"$ref": "#/components/schemas/Range",
"description": "Amount of medication per unit of time."
},
"rateQuantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "Amount of medication per unit of time."
}
}
}
]
},
"Goal": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server."
}
},
"lifecycleStatus": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The state of the goal throughout its lifecycle."
},
"achievementStatus": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Describes the progression, or lack thereof, towards the goal against the target."
},
"category": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates a category the goal falls within."
}
},
"priority": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the mutually agreed level of importance associated with reaching/sustaining the goal."
},
"description": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Human–readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\"."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the patient, group or organization for whom the goal is being established."
},
"startDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The date or event after which the goal should begin being pursued."
},
"startCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The date or event after which the goal should begin being pursued."
},
"target": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Goal_Target",
"description": "Indicates what should be done by when."
}
},
"statusDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc."
},
"statusReason": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Captures the reason for the current status."
},
"expressedBy": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates whose goal this is – patient goal, practitioner goal, etc."
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The identified conditions and other health record elements that are intended to be addressed by the goal."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Any comments related to the goal."
}
},
"outcomeCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the change (or lack of change) at the point when the status of the goal is assessed."
}
},
"outcomeReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Details of what's changed (or not changed)."
}
}
},
"required": [
"lifecycleStatus",
"description",
"subject"
]
}
],
"example": {
"resourceType": "Goal",
"meta": {
"versionId": "I0sGabpjmK",
"lastUpdated": "2021-04-12T14:34:35.65-05:00",
"source": "qPLpJtu_tw",
"profile": [
"3LX8A9B6Ra"
],
"security": [
{
"system": "VpzgWE6JFE",
"version": "C_dQjnE8J1",
"code": "DbY8dMy3KQ",
"display": "2jrndhlFNG",
"userSelected": true
}
],
"tag": [
{
"system": "kLw0dc3uHn",
"version": "ZPxAP8UtnJ",
"code": "oDQ0JMLwSS",
"display": "tWxA47xHXI",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "DxPfWig8Am",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "secondary",
"type": {
"coding": [
{
"system": "aDLC94VacE",
"version": "9tvll2HEMv",
"code": "pEgUveV0F7",
"display": "nY8OjNzhSb",
"userSelected": true
}
],
"text": "DujIpQCfrt"
},
"system": "3ZRPQbmLlc",
"value": "cvP9FxAJwn",
"period": {
"start": "2021-04-12T14:34:35.647-05:00",
"end": "2021-04-12T14:34:35.647-05:00"
}
}
],
"lifecycleStatus": "cancelled",
"achievementStatus": {
"coding": [
{
"system": "kGD0ZeEk_B",
"version": "G5FQQPj3PH",
"code": "WP3cjDT6VQ",
"display": "DeHRJgC3pf",
"userSelected": true
}
],
"text": "pLxUY5hkZc"
},
"category": [
{
"coding": [
{
"system": "pBPcLdiIMF",
"version": "bPxormdeZs",
"code": "ikAwUYCCTp",
"display": "gqsT2_YLUB",
"userSelected": true
}
],
"text": "hPN07uKd_2"
}
],
"priority": {
"coding": [
{
"system": "UccNZmOX09",
"version": "UZPGRYGku4",
"code": "uWSn1vUIb8",
"display": "C9jkH9Zuk_",
"userSelected": true
}
],
"text": "viDqjR17cl"
},
"description": {
"coding": [
{
"system": "gQfPE_CJkt",
"version": "hfbNgxzh7r",
"code": "HDMcbW8L_a",
"display": "7LZ4BHCfTy",
"userSelected": true
}
],
"text": "0zjray98M5"
},
"subject": {
"reference": "Patient/Tcboavus6W",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "P0U0l10qOF",
"version": "R8cNVMj2bT",
"code": "0p7T_hJJ_T",
"display": "965KW76GG0",
"userSelected": true
}
],
"text": "MojzfJPAzD"
},
"system": "Mbi7BD97XK",
"value": "6LYPCyFmZE",
"period": {
"start": "2021-04-12T14:34:35.648-05:00",
"end": "2021-04-12T14:34:35.648-05:00"
}
},
"display": "3nQfCvem_4"
},
"startDate": "2021-04-12",
"target": [
{
"measure": {
"coding": [
{
"system": "1tsRnrC5Rj",
"version": "dfex4KfBsZ",
"code": "Kbwf0m6mQX",
"display": "W3vqIdzx1h",
"userSelected": true
}
],
"text": "StsVjNhxBn"
},
"detailQuantity": {
"value": 473258740815,
"comparator": ">=",
"unit": "oEtrQbF9zW",
"system": "QlipwapP6Z",
"code": "9qFgOGnP8x"
},
"dueDate": "2021-04-12"
}
],
"statusDate": "2021-04-12",
"statusReason": "lmB0TEqcmq",
"expressedBy": {
"reference": "Patient/uWpZfXdCgn",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "yEDlscpkO1",
"version": "rL9ucqs2sD",
"code": "I1RqnMJkah",
"display": "EZg5tdTKVX",
"userSelected": true
}
],
"text": "yWtBRZmlBl"
},
"system": "cH0lzna6pO",
"value": "UIRvmwEgB7",
"period": {
"start": "2021-04-12T14:34:35.646-05:00",
"end": "2021-04-12T14:34:35.646-05:00"
}
},
"display": "CIrnQ8_OBQ"
},
"addresses": [
{
"reference": "Condition/BO34WXfv2j",
"type": "Condition",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "JMzXmoZu7d",
"version": "mx0g0G9bg1",
"code": "LbdAbAk_Eu",
"display": "ViejHsyQfH",
"userSelected": true
}
],
"text": "U0dyJDs4yG"
},
"system": "2Z8BlzjHgZ",
"value": "OyT9s0Y1mS",
"period": {
"start": "2021-04-12T14:34:35.65-05:00",
"end": "2021-04-12T14:34:35.65-05:00"
}
},
"display": "LkFODQqg9M"
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/P2PuXJtiRp",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "7PGbzCqbCG",
"version": "76qsO8t478",
"code": "eAy4WoumkX",
"display": "5qwcMoNtNR",
"userSelected": true
}
],
"text": "RYNK2baG0x"
},
"system": "PQ3fQWJht3",
"value": "M2jazRcGXF",
"period": {
"start": "2021-04-12T14:34:35.647-05:00",
"end": "2021-04-12T14:34:35.647-05:00"
}
},
"display": "Go03YsJ3VV"
},
"time": "2021-04-12T14:34:35.648-05:00",
"text": "gn0oNdvSka"
}
],
"outcomeCode": [
{
"coding": [
{
"system": "AflcfmGapW",
"version": "9cOZI0pzxF",
"code": "87qdtgnVYG",
"display": "JHsgESxTCE",
"userSelected": true
}
],
"text": "7ltw0Yxbht"
}
],
"outcomeReference": [
{
"reference": "Observation/KBR5FHPhiK",
"type": "Observation",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "YR4k98xrLK",
"version": "YYDtDYmme8",
"code": "JO8Oi_0aZW",
"display": "oSziCHQ2mB",
"userSelected": true
}
],
"text": "uS_FmKFnzT"
},
"system": "iNXOFsy9Qh",
"value": "7SAxcq2rFZ",
"period": {
"start": "2021-04-12T14:34:35.645-05:00",
"end": "2021-04-12T14:34:35.645-05:00"
}
},
"display": "oI2Hmr17J1"
}
]
}
},
"Goal_Target": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"measure": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level."
},
"detailQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value."
},
"detailRange": {
"$ref": "#/components/schemas/Range",
"description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value."
},
"detailCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value."
},
"detailString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value."
},
"detailBoolean": {
"type": "boolean",
"description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value."
},
"detailInteger": {
"type": "integer",
"format": "int32",
"description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value."
},
"detailRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value."
},
"dueDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Indicates either the date or the duration after start by which the goal should be met."
},
"dueDuration": {
"$ref": "#/components/schemas/Duration",
"description": "Indicates either the date or the duration after start by which the goal should be met."
}
}
}
]
},
"Immunization": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A unique identifier assigned to this immunization record."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates the current status of the immunization event."
},
"statusReason": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the reason the immunization event was not performed."
},
"vaccineCode": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Vaccine that was administered or was to be administered."
},
"patient": {
"$ref": "#/components/schemas/Reference",
"description": "The patient who either received or did not receive the immunization."
},
"encounter": {
"$ref": "#/components/schemas/Reference",
"description": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of."
},
"occurrenceDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Date vaccine administered or was to be administered."
},
"occurrenceString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Date vaccine administered or was to be administered."
},
"recorded": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date the occurrence of the immunization was first captured in the record – potentially significantly after the occurrence of the event."
},
"primarySource": {
"type": "boolean",
"description": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded."
},
"reportOrigin": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine."
},
"location": {
"$ref": "#/components/schemas/Reference",
"description": "The service delivery location where the vaccine administration occurred."
},
"manufacturer": {
"$ref": "#/components/schemas/Reference",
"description": "Name of vaccine manufacturer."
},
"lotNumber": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Lot number of the vaccine product."
},
"expirationDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Date vaccine batch expires."
},
"site": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Body site where vaccine was administered."
},
"route": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The path by which the vaccine product is taken into the body."
},
"doseQuantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The quantity of vaccine product that was administered."
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Immunization_Performer",
"description": "Indicates who performed the immunization event."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Extra information about the immunization that is not conveyed by the other attributes."
}
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Reasons why the vaccine was administered."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Condition, Observation or DiagnosticReport that supports why the immunization was administered."
}
},
"isSubpotent": {
"type": "boolean",
"description": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent."
},
"subpotentReason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Reason why a dose is considered to be subpotent."
}
},
"education": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Immunization_Education",
"description": "Educational material presented to the patient (or guardian) at the time of vaccine administration."
}
},
"programEligibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates a patient's eligibility for a funding program."
}
},
"fundingSource": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered)."
},
"reaction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Immunization_Reaction",
"description": "Categorical data indicating that an adverse event is associated in time to an immunization."
}
},
"protocolApplied": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Immunization_ProtocolApplied",
"description": "The protocol (set of recommendations) being followed by the provider who administered the dose."
}
}
},
"required": [
"status",
"vaccineCode",
"patient"
]
}
],
"example": {
"resourceType": "Immunization",
"meta": {
"versionId": "u0ay9MtPHR",
"lastUpdated": "2021-04-12T14:34:33.963-05:00",
"source": "CLFSX3i8HY",
"profile": [
"GFWUG9Qpch"
],
"security": [
{
"system": "317NiztyIT",
"version": "wj9O8nwqMI",
"code": "t6idU_zUVc",
"display": "6zFJ_2Rc_R",
"userSelected": true
}
],
"tag": [
{
"system": "3r_su9719i",
"version": "oNAj5mzmAC",
"code": "0Y57yuDXNK",
"display": "u0W6SuGU6c",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "dbsw6tiViM",
"language": "en-US",
"text": {
"status": "empty",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "old",
"type": {
"coding": [
{
"system": "1a5naYo7U0",
"version": "D6d0kKrEjB",
"code": "5a2AbENu_m",
"display": "RnhR1nxSq0",
"userSelected": true
}
],
"text": "kqSm3gxp3b"
},
"system": "ifENLtxBfD",
"value": "PWuzrmC7d7",
"period": {
"start": "2021-04-12T14:34:33.95-05:00",
"end": "2021-04-12T14:34:33.95-05:00"
}
}
],
"status": "not-done",
"statusReason": {
"coding": [
{
"system": "8a4xYwpTRk",
"version": "q1d2y2qY00",
"code": "8MBTeQlSCz",
"display": "hi3wKxV8iO",
"userSelected": true
}
],
"text": "AzQtDkMeFN"
},
"vaccineCode": {
"coding": [
{
"system": "knJ85sYef6",
"version": "KvwbbjFRNs",
"code": "_6VNaXs4jf",
"display": "P05CrwAELV",
"userSelected": true
}
],
"text": "5HPN2ZYkYW"
},
"patient": {
"reference": "Patient/Nl5vm2KDlP",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "hw8Tug4c4D",
"version": "JUAklhdI3N",
"code": "h0DrL_3FT_",
"display": "6hTfb3FTUC",
"userSelected": true
}
],
"text": "4F_vhmOCLJ"
},
"system": "Nxuvp6fjAK",
"value": "prBWQi0ti6",
"period": {
"start": "2021-04-12T14:34:33.949-05:00",
"end": "2021-04-12T14:34:33.949-05:00"
}
},
"display": "VCNIr1Sk7A"
},
"encounter": {
"reference": "Encounter/jYxKniGja5",
"type": "Encounter",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "7b3EdLSo9L",
"version": "nf401ccc4C",
"code": "c1o28OFItE",
"display": "8B7Jc0dyH6",
"userSelected": true
}
],
"text": "ZQ8V1GYSRG"
},
"system": "lvpyJdxkz8",
"value": "87cYXoZXAq",
"period": {
"start": "2021-04-12T14:34:33.96-05:00",
"end": "2021-04-12T14:34:33.96-05:00"
}
},
"display": "Erx8JLsioH"
},
"occurrenceDateTime": "2021-04-12T14:34:33.951-05:00",
"recorded": "2021-04-12T14:34:33.949-05:00",
"primarySource": true,
"reportOrigin": {
"coding": [
{
"system": "Ca9Fwc1E4W",
"version": "5tpEZP6Dsb",
"code": "XpzUFHRXRR",
"display": "BxBG0gKLGj",
"userSelected": true
}
],
"text": "RSMm5R2MFo"
},
"location": {
"reference": "Location/1t1bmvRQ32",
"type": "Location",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "br0dMeknuh",
"version": "PeqhW6yBiU",
"code": "OD4ITg5QEL",
"display": "0QpFiL9CHq",
"userSelected": true
}
],
"text": "E7q9b7ZmfP"
},
"system": "i9HsuZ3syP",
"value": "3xv_hGQvJx",
"period": {
"start": "2021-04-12T14:34:33.962-05:00",
"end": "2021-04-12T14:34:33.962-05:00"
}
},
"display": "xqTXlnAhSL"
},
"manufacturer": {
"reference": "Organization/Ni0dKHSbtc",
"type": "Organization",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "2lVl2tcWm6",
"version": "ZwGc6rZD8D",
"code": "NJG__gbMbx",
"display": "6vDO66HjpR",
"userSelected": true
}
],
"text": "a_cAlGXMbi"
},
"system": "Ls8_raTSGz",
"value": "J9Z0rPUM14",
"period": {
"start": "2021-04-12T14:34:33.95-05:00",
"end": "2021-04-12T14:34:33.95-05:00"
}
},
"display": "jYiq0DHT1r"
},
"lotNumber": "Jk5ctHnhCr",
"expirationDate": "2021-04-12",
"site": {
"coding": [
{
"system": "2BP0usJxJj",
"version": "ccG3fr2tll",
"code": "thvuLMapXX",
"display": "H6whlUeQc6",
"userSelected": true
}
],
"text": "LzsY3sGuP5"
},
"route": {
"coding": [
{
"system": "PW5yKVBkCK",
"version": "hCKNa9J8DJ",
"code": "MzbRjcN5Eh",
"display": "M4Lx5cAf_T",
"userSelected": true
}
],
"text": "G5rLK4s_dX"
},
"doseQuantity": {
"value": 336702635843,
"unit": "qALuGZ0RJC",
"system": "xE50VeI0Ha",
"code": "W5y1rkfMEl"
},
"performer": [
{
"function": {
"coding": [
{
"system": "clnrt0T6Sf",
"version": "vVg4srrozV",
"code": "E0_aePxXOQ",
"display": "Fqb5MhykcP",
"userSelected": true
}
],
"text": "meRI71B9C0"
},
"actor": {
"reference": "Practitioner/5dOF7rayKB",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "e9yYW_MaJ9",
"version": "30TuT4xdlJ",
"code": "5fBMd6M5_H",
"display": "Jewxf79VdV",
"userSelected": true
}
],
"text": "Fsig3rEpIi"
},
"system": "4tRWIi9prr",
"value": "TZIXkgO8nT",
"period": {
"start": "2021-04-12T14:34:33.952-05:00",
"end": "2021-04-12T14:34:33.952-05:00"
}
},
"display": "iAiS54Yn3N"
}
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/iVkxLIH6zG",
"type": "Practitioner",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "KZ8GG6wNgl",
"version": "ADuWpMJIfB",
"code": "ouXLMC9q9E",
"display": "IGvF3AoeN3",
"userSelected": true
}
],
"text": "zdADT6sNq9"
},
"system": "_2bi3eFRgo",
"value": "qXfujUCR2b",
"period": {
"start": "2021-04-12T14:34:33.953-05:00",
"end": "2021-04-12T14:34:33.953-05:00"
}
},
"display": "0trHTAKJsw"
},
"time": "2021-04-12T14:34:33.954-05:00",
"text": "RzebB0aQ0x"
}
],
"reasonCode": [
{
"coding": [
{
"system": "Xubrd0tUTj",
"version": "TY4KAzfcrt",
"code": "8oDr4d12Gh",
"display": "FzAbwDqr0n",
"userSelected": true
}
],
"text": "B6n32Bjkdt"
}
],
"reasonReference": [
{
"reference": "Condition/nJCw4mKy1c",
"type": "Condition",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "5825QvUPyZ",
"version": "GTSwBf04tm",
"code": "IToyO3259O",
"display": "9rqU_QnUEP",
"userSelected": true
}
],
"text": "Cz_fPEw6Tv"
},
"system": "X3j47eP8fl",
"value": "XUweyPJ26j",
"period": {
"start": "2021-04-12T14:34:33.948-05:00",
"end": "2021-04-12T14:34:33.948-05:00"
}
},
"display": "aLbbGeSkvv"
}
],
"isSubpotent": true,
"subpotentReason": [
{
"coding": [
{
"system": "oquEFZa7qq",
"version": "_iQLr9kzrj",
"code": "ORKyQSyAR3",
"display": "G8SxMfd2VZ",
"userSelected": true
}
],
"text": "Yu6tG5z2C7"
}
],
"education": [
{
"documentType": "DCAZsP1Gqp",
"reference": "E4MYvXNm5v",
"publicationDate": "2021-04-12T14:34:33.957-05:00",
"presentationDate": "2021-04-12T14:34:33.957-05:00"
}
],
"programEligibility": [
{
"coding": [
{
"system": "473mmmtkjk",
"version": "1DxWXvWgC8",
"code": "A8m8eTxFF3",
"display": "oo4KNB4Fhs",
"userSelected": true
}
],
"text": "uLqCbWJwdw"
}
],
"fundingSource": {
"coding": [
{
"system": "shJq7TJ2II",
"version": "Tr8OgB8uI4",
"code": "KtudcJbouB",
"display": "1kCkczZTTs",
"userSelected": true
}
],
"text": "3ST61qFy2j"
},
"reaction": [
{
"date": "2021-04-12T14:34:33.955-05:00",
"detail": {
"reference": "Observation/GS7tSnD23F",
"type": "Observation",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "9xgjgK3iGZ",
"version": "X9Ufv9UyVc",
"code": "cYpcDQUYbB",
"display": "UQeOxm4n6X",
"userSelected": true
}
],
"text": "boASecvLos"
},
"system": "uPv2ny8_Gt",
"value": "VDx3gY06O8",
"period": {
"start": "2021-04-12T14:34:33.954-05:00",
"end": "2021-04-12T14:34:33.955-05:00"
}
},
"display": "N9GgAS2uJY"
},
"reported": true
}
],
"protocolApplied": [
{
"series": "Zutli7bAs7",
"authority": {
"reference": "Organization/mQwjNdBwYd",
"type": "Organization",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "xNa_ID74Z9",
"version": "O6AkhB3Dwr",
"code": "f00RxOVuv1",
"display": "E2cSWgtK7x",
"userSelected": true
}
],
"text": "nahthUzuRh"
},
"system": "TtvVaQBmTY",
"value": "B8HNh3PuH6",
"period": {
"start": "2021-04-12T14:34:33.959-05:00",
"end": "2021-04-12T14:34:33.959-05:00"
}
},
"display": "Ibcay96YJ1"
},
"targetDisease": [
{
"coding": [
{
"system": "7xpNO7Oj0g",
"version": "j8Pz8izQtp",
"code": "36NJxLt34k",
"display": "h7ctYUZd8v",
"userSelected": true
}
],
"text": "9SqdvSQgXl"
}
],
"doseNumberPositiveInt": 934588861,
"seriesDosesPositiveInt": 457672628
}
]
}
},
"Immunization_Education": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"documentType": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Identifier of the material presented to the patient."
},
"reference": {
"type": "string",
"pattern": "\\S*",
"description": "Reference pointer to the educational material given to the patient if the information was on line."
},
"publicationDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Date the educational material was published."
},
"presentationDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Date the educational material was given to the patient."
}
}
}
]
},
"Immunization_Performer": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"function": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Describes the type of performance (e.g. ordering provider, administering provider, etc.)."
},
"actor": {
"$ref": "#/components/schemas/Reference",
"description": "The practitioner or organization who performed the action."
}
},
"required": [
"actor"
]
}
]
},
"Immunization_ProtocolApplied": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"series": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "One possible path to achieve presumed immunity against a disease – within the context of an authority."
},
"authority": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed."
},
"targetDisease": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The vaccine preventable disease the dose is being administered against."
}
},
"doseNumberPositiveInt": {
"type": "integer",
"format": "int32",
"description": "Nominal position in a series."
},
"doseNumberString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Nominal position in a series."
},
"seriesDosesPositiveInt": {
"type": "integer",
"format": "int32",
"description": "The recommended number of doses to achieve immunity."
},
"seriesDosesString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The recommended number of doses to achieve immunity."
}
}
}
]
},
"Immunization_Reaction": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Date of reaction to the immunization."
},
"detail": {
"$ref": "#/components/schemas/Reference",
"description": "Details of the reaction."
},
"reported": {
"type": "boolean",
"description": "Self–reported indicator."
}
}
}
]
},
"Location": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Unique code or number identifying the location to its users."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location."
},
"operationalStatus": {
"$ref": "#/components/schemas/Coding",
"description": "The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Name of the location as used by humans. Does not need to be unique."
},
"alias": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A list of alternate names that the location is known as, or was known as, in the past."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Description of the Location, which helps in finding or referencing the place."
},
"mode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates whether a resource instance represents a specific location or a class of locations."
},
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the type of function performed at the location."
}
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites."
}
},
"address": {
"$ref": "#/components/schemas/Address",
"description": "Physical location."
},
"physicalType": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Physical form of the location, e.g. building, room, vehicle, road."
},
"position": {
"$ref": "#/components/schemas/Location_Position",
"description": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co–ordinate system used in KML)."
},
"managingOrganization": {
"$ref": "#/components/schemas/Reference",
"description": "The organization responsible for the provisioning and upkeep of the location."
},
"partOf": {
"$ref": "#/components/schemas/Reference",
"description": "Another Location of which this Location is physically a part of."
},
"hoursOfOperation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location_HoursOfOperation",
"description": "What days/times during a week is this location usually open."
}
},
"availabilityExceptions": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times."
},
"endpoint": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Technical endpoints providing access to services operated for the location."
}
}
}
}
],
"example": {
"resourceType": "Location",
"meta": {
"versionId": "cx3-OC0Oqm",
"lastUpdated": "2021-04-12T14:34:25.289-05:00",
"source": "NuscVnHo4l",
"profile": [
"eaPgbqNKTR"
],
"security": [
{
"system": "VVxdxgI2Ay",
"version": "GfmQRmPgA8",
"code": "XPR1VK4fKM",
"display": "ANtF31232Z",
"userSelected": true
}
],
"tag": [
{
"system": "c26ikccOK5",
"version": "4L6ew5qsQL",
"code": "uRJqWalfb_",
"display": "mO6GplidZj",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "ppzNVtp7ki",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "coENIcO_kt",
"version": "_svZdkVkYO",
"code": "XNw_Z8AArV",
"display": "_6DwFduMDI",
"userSelected": true
}
],
"text": "b2Rw57iKYP"
},
"system": "vbWyxGMBhb",
"value": "8GmjuF1VUN",
"period": {
"start": "2021-04-12T14:34:25.275-05:00",
"end": "2021-04-12T14:34:25.275-05:00"
}
}
],
"status": "suspended",
"operationalStatus": {
"system": "9R8g3K8cdZ",
"version": "GdK7M3PedB",
"code": "dcVpnNhKkI",
"display": "jkV7hKQ5IB",
"userSelected": true
},
"name": "JgLU7VGXfE",
"alias": [
"HacpxvDgPM"
],
"description": "8CoG7J3O9D",
"mode": "kind",
"type": [
{
"coding": [
{
"system": "XdTyfuJzkT",
"version": "RE7bUyTtsJ",
"code": "GgaLGgmtLZ",
"display": "dnFn7S7ELR",
"userSelected": true
}
],
"text": "Brjq4fm2R1"
}
],
"telecom": [
{
"system": "url",
"value": "UkzQMEN_Xx",
"use": "mobile",
"rank": 1019771301,
"period": {
"start": "2021-04-12T14:34:25.278-05:00",
"end": "2021-04-12T14:34:25.278-05:00"
}
}
],
"address": {
"use": "billing",
"type": "physical",
"text": "qzw6dEgoKd",
"line": [
"dSRv7wv6S_"
],
"city": "0RfM2qdDDX",
"district": "1ozuv2yEZY",
"state": "ICMJLjZaTF",
"postalCode": "_VXO3XDPmd",
"country": "ONKovxZdAT",
"period": {
"start": "2021-04-12T14:34:25.283-05:00",
"end": "2021-04-12T14:34:25.284-05:00"
}
},
"physicalType": {
"coding": [
{
"system": "qQp05coc5r",
"version": "TQK6LRXusk",
"code": "Bgfy97W0wc",
"display": "CfpfdMtUDf",
"userSelected": true
}
],
"text": "vKpEn9TOiU"
},
"position": {
"longitude": 511759576616,
"latitude": 438849716000,
"altitude": 276088500786
},
"managingOrganization": {
"reference": "Organization/EXZ7l17QB7",
"type": "Organization",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "HD6xQqiwfa",
"version": "phkXsMzkbl",
"code": "QbSl77mXbR",
"display": "NlHdgAtmDA",
"userSelected": true
}
],
"text": "JZuWB368c4"
},
"system": "OGkhro1fGD",
"value": "tGtpB_M7u4",
"period": {
"start": "2021-04-12T14:34:25.278-05:00",
"end": "2021-04-12T14:34:25.279-05:00"
}
},
"display": "77SesQMoqP"
},
"partOf": {
"reference": "Location/Dgxs77lZgQ",
"type": "Location",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "bauIu5Drrz",
"version": "K_kFJBTNht",
"code": "X6Fibavx05",
"display": "I3aGZPZ9Tn",
"userSelected": true
}
],
"text": "Zt7NkTF9da"
},
"system": "3Rg1tB0OmS",
"value": "J40mukPLDg",
"period": {
"start": "2021-04-12T14:34:25.274-05:00",
"end": "2021-04-12T14:34:25.274-05:00"
}
},
"display": "yHdEgXuSP9"
},
"hoursOfOperation": [
{
"daysOfWeek": [
"wed"
],
"allDay": true,
"openingTime": "14:34:25.293",
"closingTime": "14:34:25.293"
}
],
"availabilityExceptions": "JR2SHcS7gd",
"endpoint": [
{
"reference": "Endpoint/fGbifR6pXX",
"type": "Endpoint",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "BEVNWZRzzL",
"version": "JfonAGnnEt",
"code": "L_TVYa_2XL",
"display": "bUJt69mhid",
"userSelected": true
}
],
"text": "PP_ENkBra1"
},
"system": "o8lFV7P5pQ",
"value": "tEOCJrTQUW",
"period": {
"start": "2021-04-12T14:34:25.276-05:00",
"end": "2021-04-12T14:34:25.276-05:00"
}
},
"display": "m8tb1qL7v8"
}
]
}
},
"Location_HoursOfOperation": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"daysOfWeek": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates which days of the week are available between the start and end Times."
}
},
"allDay": {
"type": "boolean",
"description": "The Location is open all day."
},
"openingTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "Time that the Location opens."
},
"closingTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "Time that the Location closes."
}
}
}
]
},
"Location_Position": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"longitude": {
"type": "number",
"description": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below)."
},
"latitude": {
"type": "number",
"description": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below)."
},
"altitude": {
"type": "number",
"description": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below)."
}
},
"required": [
"longitude",
"latitude"
]
}
]
},
"Medication": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business identifier for this medication."
}
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems."
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code to indicate if the medication is in active use."
},
"manufacturer": {
"$ref": "#/components/schemas/Reference",
"description": "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product."
},
"form": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Describes the form of the item. Powder; tablets; capsule."
},
"amount": {
"$ref": "#/components/schemas/Ratio",
"description": "Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.)."
},
"ingredient": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Medication_Ingredient",
"description": "Identifies a particular constituent of interest in the product."
}
},
"batch": {
"$ref": "#/components/schemas/Medication_Batch",
"description": "Information that only applies to packages (not products)."
}
}
}
],
"example": {
"resourceType": "Medication",
"meta": {
"versionId": "PLaUVt99Bp",
"lastUpdated": "2021-04-12T14:34:36.548-05:00",
"source": "SAPCE7dREy",
"profile": [
"wSV_jCZjip"
],
"security": [
{
"system": "1ZZC7lajKk",
"version": "ea9RLpzpTa",
"code": "G_6dn_uiuY",
"display": "RAKLKhPE2f",
"userSelected": true
}
],
"tag": [
{
"system": "B38CcxqKjl",
"version": "pcQfi5K5vY",
"code": "DwvgI1Q3Vc",
"display": "i4oqfZ65YY",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "WAcDQnxUNg",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "temp",
"type": {
"coding": [
{
"system": "CflsAodLCs",
"version": "W_nctxxh9g",
"code": "KTqdoeIB2z",
"display": "7nbXbVxh5B",
"userSelected": true
}
],
"text": "yv3AE1jcZP"
},
"system": "QVlkEbODsZ",
"value": "dnpvOSj1MB",
"period": {
"start": "2021-04-12T14:34:36.544-05:00",
"end": "2021-04-12T14:34:36.544-05:00"
}
}
],
"code": {
"coding": [
{
"system": "Jk0sEb5dA_",
"version": "pruv6aPcY7",
"code": "Mole4_1hNE",
"display": "p7TPxEkeb2",
"userSelected": true
}
],
"text": "TiVdiiJfcX"
},
"status": "entered-in-error",
"manufacturer": {
"reference": "Organization/CHmpWFQxCC",
"type": "Organization",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "LGZG_KLBg6",
"version": "T3UZPFAfJU",
"code": "aSoYALpQWY",
"display": "ktkvgBzeAB",
"userSelected": true
}
],
"text": "epP915J80C"
},
"system": "zX7GgEh3xS",
"value": "pwmeYGrnwd",
"period": {
"start": "2021-04-12T14:34:36.543-05:00",
"end": "2021-04-12T14:34:36.543-05:00"
}
},
"display": "aXd9nWXmaP"
},
"form": {
"coding": [
{
"system": "bCJJr49ZWU",
"version": "LrgJZplfTZ",
"code": "GiTjjOS5Tu",
"display": "DIxRk6BP9Z",
"userSelected": true
}
],
"text": "7bAixPIvs7"
},
"amount": {
"numerator": {
"value": 520920781925,
"comparator": "<=",
"unit": "Bfz86rfPeF",
"system": "noBs4vEIdp",
"code": "3pFJqGE5Vq"
},
"denominator": {
"value": 232102196305,
"comparator": "<",
"unit": "cefC23WMKT",
"system": "q1EM8qfqtq",
"code": "HX_OsCmtv8"
}
},
"ingredient": [
{
"itemCodeableConcept": {
"coding": [
{
"system": "rOSWOL_c7D",
"version": "ROyWM9nc8k",
"code": "6oeyV1bIRr",
"display": "Sq3xC1l_t3",
"userSelected": true
}
],
"text": "mxTeVuoSf8"
},
"isActive": true,
"strength": {
"numerator": {
"value": 289056119635,
"comparator": ">",
"unit": "YZIpsSwuC_",
"system": "0Zy8oPi8Wa",
"code": "bryQZ3HhBC"
},
"denominator": {
"value": 396938663531,
"comparator": ">",
"unit": "9gYBOt1oPQ",
"system": "kHBwQBVqZH",
"code": "VzdT_1MAoU"
}
}
}
],
"batch": {
"lotNumber": "gsnmlU5irj",
"expirationDate": "2021-04-12T14:34:36.55-05:00"
}
}
},
"Medication_Batch": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"lotNumber": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The assigned lot number of a batch of the specified product."
},
"expirationDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "When this specific batch of product will expire."
}
}
}
]
},
"Medication_Ingredient": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"itemCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The actual ingredient – either a substance (simple ingredient) or another medication of a medication."
},
"itemReference": {
"$ref": "#/components/schemas/Reference",
"description": "The actual ingredient – either a substance (simple ingredient) or another medication of a medication."
},
"isActive": {
"type": "boolean",
"description": "Indication of whether this ingredient affects the therapeutic action of the drug."
},
"strength": {
"$ref": "#/components/schemas/Ratio",
"description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet."
}
}
}
]
},
"MedicationDispense": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server."
}
},
"partOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The procedure that trigger the dispense."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code specifying the state of the set of dispense events."
},
"statusReasonCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the reason why a dispense was not performed."
},
"statusReasonReference": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates the reason why a dispense was not performed."
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient))."
},
"medicationCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications."
},
"medicationReference": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "A link to a resource representing the person or the group to whom the medication will be given."
},
"context": {
"$ref": "#/components/schemas/Reference",
"description": "The encounter or episode of care that establishes the context for this event."
},
"supportingInformation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Additional information that supports the medication being dispensed."
}
},
"performer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MedicationDispense_Performer",
"description": "Indicates who or what performed the event."
}
},
"location": {
"$ref": "#/components/schemas/Reference",
"description": "The principal physical location where the dispense was performed."
},
"authorizingPrescription": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates the medication order that is being dispensed against."
}
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."
},
"quantity": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The amount of medication that has been dispensed. Includes unit of measure."
},
"daysSupply": {
"$ref": "#/components/schemas/SimpleQuantity",
"description": "The amount of medication expressed as a timing amount."
},
"whenPrepared": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The time when the dispensed product was packaged and reviewed."
},
"whenHandedOver": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The time the dispensed product was provided to the patient or their representative."
},
"destination": {
"$ref": "#/components/schemas/Reference",
"description": "Identification of the facility/location where the medication was shipped to, as part of the dispense event."
},
"receiver": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Extra information about the dispense that could not be conveyed in the other attributes."
}
},
"dosageInstruction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dosage",
"description": "Indicates how the medication is to be used by the patient."
}
},
"substitution": {
"$ref": "#/components/schemas/MedicationDispense_Substitution",
"description": "Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done."
},
"detectedIssue": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug–drug interaction, duplicate therapy, dosage alert etc."
}
},
"eventHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A summary of the events of interest that have occurred, such as when the dispense was verified."
}
}
},
"required": [
"status"
]
}
],
"example": {
"resourceType": "MedicationDispense",
"meta": {
"versionId": "tHDG6WWIGz",
"lastUpdated": "2021-04-12T14:34:28.261-05:00",
"source": "dZBhuSfSdB",
"profile": [
"vOyK2EvvNX"
],
"security": [
{
"system": "T9StdKKBF3",
"version": "dU2lnvvWRG",
"code": "NMUSI_4CKa",
"display": "U8C9WVU88t",
"userSelected": true
}
],
"tag": [
{
"system": "lq_lAOEWPt",
"version": "13Sq6aOEr4",
"code": "vJTd3dg485",
"display": "pPr4rW10le",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "KAeyrCn0gb",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "secondary",
"type": {
"coding": [
{
"system": "rN4R88liLS",
"version": "RdZRPZNC1j",
"code": "GskGEtwXew",
"display": "Iwx_pHDnwX",
"userSelected": true
}
],
"text": "VUbftjDt3M"
},
"system": "BRilrGbHYH",
"value": "Ne9chlkSiW",
"period": {
"start": "2021-04-12T14:34:28.249-05:00",
"end": "2021-04-12T14:34:28.249-05:00"
}
}
],
"partOf": [
{
"reference": "Procedure/0-0AUOIx2C",
"type": "Procedure",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "6N6pQ7hW8Z",
"version": "bDG19uIr1V",
"code": "RulGsJIs8J",
"display": "IBx9KumOXr",
"userSelected": true
}
],
"text": "b53wFJ38Wi"
},
"system": "8Y3LNQka6G",
"value": "K48cCgzWnm",
"period": {
"start": "2021-04-12T14:34:28.235-05:00",
"end": "2021-04-12T14:34:28.236-05:00"
}
},
"display": "ZE3Nfs1Mqn"
}
],
"status": "stopped",
"statusReasonCodeableConcept": {
"coding": [
{
"system": "V9SNFp66tn",
"version": "uBkMfPDprQ",
"code": "QwxarfzYr1",
"display": "HtKC3_14KY",
"userSelected": true
}
],
"text": "PLbuvz0E3H"
},
"category": {
"coding": [
{
"system": "AwANlQpjEK",
"version": "4p0B0XTzzN",
"code": "Z3prav4W4j",
"display": "cIa0y_MDnk",
"userSelected": true
}
],
"text": "v52BCXGjYm"
},
"medicationCodeableConcept": {
"coding": [
{
"system": "iN4ce_Bicj",
"version": "ZnG1Cu4KlQ",
"code": "FNKWkHJg0z",
"display": "J2XAFnrIh_",
"userSelected": true
}
],
"text": "uEFjeRGcBu"
},
"subject": {
"reference": "Patient/JBRxQc85De",
"type": "Patient",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "aP7SdJ6Fcm",
"version": "WQzmzO2n7A",
"code": "A173OWL3ds",
"display": "aYtGX0kx5w",
"userSelected": true
}
],
"text": "HjuHT9CvH3"
},
"system": "WosUqYXACZ",
"value": "3VANOpf2xe",
"period": {
"start": "2021-04-12T14:34:28.254-05:00",
"end": "2021-04-12T14:34:28.254-05:00"
}
},
"display": "lWenxhfFfk"
},
"context": {
"reference": "Encounter/0SDmdETA6c",
"type": "Encounter",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "kh9H1V12wV",
"version": "sCTrcfN4tt",
"code": "N8nf2usNif",
"display": "t3B9hY7IRK",
"userSelected": true
}
],
"text": "NI0sqp0iPT"
},
"system": "5YsVjMOdjJ",
"value": "MtRPQUjstB",
"period": {
"start": "2021-04-12T14:34:28.256-05:00",
"end": "2021-04-12T14:34:28.256-05:00"
}
},
"display": "s5xTieRktO"
},
"supportingInformation": [
{
"reference": "Basic/YvooAviWf6",
"type": "Basic",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "YutVcW1ybF",
"version": "3XqgRCPEAl",
"code": "oEueEt8hBK",
"display": "kbYPUADhN6",
"userSelected": true
}
],
"text": "XTYgJVYVi0"
},
"system": "NmzezMAN5u",
"value": "L_p82Pchry",
"period": {
"start": "2021-04-12T14:34:28.237-05:00",
"end": "2021-04-12T14:34:28.237-05:00"
}
},
"display": "xAfuigiM3i"
}
],
"performer": [
{
"function": {
"coding": [
{
"system": "tVgfWDVpoB",
"version": "LcSOanjWoM",
"code": "Zm_QVqRovD",
"display": "QxCDQj6rKo",
"userSelected": true
}
],
"text": "A4WiO9dO7y"
},
"actor": {
"reference": "Practitioner/uHfx7pzZRN",
"type": "Practitioner",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "hkh2eNZPhE",
"version": "ASbJMk5zQ2",
"code": "WPga9LxP2E",
"display": "yfPM_ReoDG",
"userSelected": true
}
],
"text": "OVJL8G3sIq"
},
"system": "Ev7v2jeoDL",
"value": "UzAPhCFEtR",
"period": {
"start": "2021-04-12T14:34:28.251-05:00",
"end": "2021-04-12T14:34:28.252-05:00"
}
},
"display": "6FdhqdmO4P"
}
}
],
"location": {
"reference": "Location/FUUUcEnT8f",
"type": "Location",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "bsSsb9ZPLb",
"version": "vGFqqHLit8",
"code": "ZumeiUPA9J",
"display": "DECuUycJqs",
"userSelected": true
}
],
"text": "M0UrRyRsED"
},
"system": "76wl9whh4L",
"value": "GApI4Adlez",
"period": {
"start": "2021-04-12T14:34:28.257-05:00",
"end": "2021-04-12T14:34:28.258-05:00"
}
},
"display": "Qyc1Iw_XKZ"
},
"authorizingPrescription": [
{
"reference": "MedicationRequest/XayhAlg3y0",
"type": "MedicationRequest",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "O2fuCMrRRn",
"version": "djKDVnRaw9",
"code": "Tn6uHyLOnw",
"display": "UzA0afk3tX",
"userSelected": true
}
],
"text": "QvL3h0jZQX"
},
"system": "zYRnRDNPLl",
"value": "NY7fR27wag",
"period": {
"start": "2021-04-12T14:34:28.238-05:00",
"end": "2021-04-12T14:34:28.238-05:00"
}
},
"display": "ocspdMe5qy"
}
],
"type": {
"coding": [
{
"system": "ItvPRRsOlX",
"version": "I3xDYiXQ1_",
"code": "H_WOQgMvPU",
"display": "gH4lgcRwHo",
"userSelected": true
}
],
"text": "q5XsynCKPE"
},
"quantity": {
"value": 27888075537,
"unit": "VwznuC0yMt",
"system": "ve8C2lxBT4",
"code": "PnWlc5wK6t"
},
"daysSupply": {
"value": 344979821853,
"unit": "_To7F4CEda",
"system": "fJ9QZF9rPp",
"code": "Wj3Vv08bSX"
},
"whenPrepared": "2021-04-12T14:34:28.24-05:00",
"whenHandedOver": "2021-04-12T14:34:28.24-05:00",
"destination": {
"reference": "Location/3wcx-4sMOw",
"type": "Location",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "3oYlit2tg5",
"version": "h4lOhkteq2",
"code": "gyPWkcHajQ",
"display": "Tk_HOMKNu7",
"userSelected": true
}
],
"text": "BF36VyVfGg"
},
"system": "vX5w9zEgFo",
"value": "LbGBUjXIwH",
"period": {
"start": "2021-04-12T14:34:28.234-05:00",
"end": "2021-04-12T14:34:28.234-05:00"
}
},
"display": "JjD3G14SjJ"
},
"receiver": [
{
"reference": "Patient/7-TGh-lpIc",
"type": "Patient",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "wsjqOG1Pk_",
"version": "WJ7onDnSzk",
"code": "hYoWZ5riNU",
"display": "pGIt2nz0gW",
"userSelected": true
}
],
"text": "Yh8guUI0Gb"
},
"system": "ZPx2mg2yqr",
"value": "mvEC0mLZgb",
"period": {
"start": "2021-04-12T14:34:28.256-05:00",
"end": "2021-04-12T14:34:28.257-05:00"
}
},
"display": "BBczCczRHY"
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/1YkS7POYcu",
"type": "Practitioner",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "kNmX4r0USE",
"version": "Tj51yDv9Fz",
"code": "mToddUiaXu",
"display": "E3oRAUCFEr",
"userSelected": true
}
],
"text": "pt7lPNidXR"
},
"system": "E1EnO_y7tE",
"value": "BPvlIrey9p",
"period": {
"start": "2021-04-12T14:34:28.253-05:00",
"end": "2021-04-12T14:34:28.253-05:00"
}
},
"display": "Yaj3nHkY7J"
},
"time": "2021-04-12T14:34:28.254-05:00",
"text": "YnsN5h93Yz"
}
],
"dosageInstruction": [
{
"sequence": 1608038774,
"text": "I3uprR1I4d",
"additionalInstruction": [
{
"coding": [
{
"system": "GjPi9aS5_n",
"version": "S8Bg4km4A8",
"code": "oAS9N5Hi11",
"display": "sPkn5jGhHs",
"userSelected": true
}
],
"text": "Wj1M9c8gGs"
}
],
"patientInstruction": "PjffKSatfj",
"timing": {
"event": [
"2021-04-12T14:34:28.242-05:00"
],
"repeat": {
"boundsDuration": {
"value": 139224512607,
"comparator": ">",
"unit": "UX240RGPOH",
"system": "http://unitsofmeasure.org",
"code": "h"
},
"count": 202201029,
"countMax": 678572512,
"duration": 542532310056,
"durationMax": 314362854161,
"durationUnit": "mo",
"frequency": 943365043,
"frequencyMax": 1426293933,
"period": 120399469317,
"periodMax": 178013225269,
"periodUnit": "mo",
"dayOfWeek": [
"thu"
],
"when": [
"C"
]
},
"code": {
"coding": [
{
"system": "npyoq6dR09",
"version": "rR4vL53YHb",
"code": "IPOOcyoIEm",
"display": "yWOMP_W6td",
"userSelected": true
}
],
"text": "j36uB8H1ne"
}
},
"asNeededBoolean": true,
"site": {
"coding": [
{
"system": "uQgBEtF2g9",
"version": "8X7AUqVN_k",
"code": "zpfJXHQLak",
"display": "ug2adQ0AK1",
"userSelected": true
}
],
"text": "JSmxTrtqyD"
},
"route": {
"coding": [
{
"system": "fywfB7Pq1Z",
"version": "vWBYXbBhxy",
"code": "w7uqfYKsmU",
"display": "eT2YiISyIV",
"userSelected": true
}
],
"text": "tyUIMmYjqf"
},
"method": {
"coding": [
{
"system": "LR65bLbvL0",
"version": "qgZjewh_q4",
"code": "dd94W6LcQA",
"display": "YhSiPeBqYd",
"userSelected": true
}
],
"text": "VAfvDFSx49"
},
"doseAndRate": [
{
"type": {
"coding": [
{
"system": "51SjxOqxUW",
"version": "e4xnltIsVZ",
"code": "LElGKD9T5T",
"display": "UOOZhEo9Mv",
"userSelected": true
}
],
"text": "vKL5WulGGL"
},
"doseRange": {
"low": {
"value": 10557157493,
"unit": "zThClYssai",
"system": "JZK3bDNUBM",
"code": "CDnWuaG_kv"
}
},
"rateRatio": {
"numerator": {
"value": 409353136901,
"comparator": ">",
"unit": "PeETPR5uiD",
"system": "GEaHDlIvz_",
"code": "eHZ1nuDYSB"
},
"denominator": {
"value": 521454502199,
"comparator": "<",
"unit": "N0MbnkPwEV",
"system": "37egwFT0tW",
"code": "vmPlCtfROJ"
}
}
}
],
"maxDosePerPeriod": {
"numerator": {
"value": 116267832169,
"comparator": "<=",
"unit": "JhN2vYedFT",
"system": "eXJ6yOr7zH",
"code": "Gklymr6jHD"
},
"denominator": {
"value": 31161521275,
"comparator": "<",
"unit": "dHtMgRf4CQ",
"system": "VIsr6T84XP",
"code": "KGNAqgNwj9"
}
},
"maxDosePerAdministration": {
"value": 270902582134,
"unit": "vgAgGsmViT",
"system": "hs8AUIGqhA",
"code": "8VBg0aATr0"
},
"maxDosePerLifetime": {
"value": 482754494512,
"unit": "9f5GGDxtSB",
"system": "hG5Q6gwUkd",
"code": "Ot_fQ4Nao6"
}
}
],
"substitution": {
"wasSubstituted": true,
"type": {
"coding": [
{
"system": "gk6HNubhfb",
"version": "m5Tw3InAeg",
"code": "EQ0EQMQAqR",
"display": "Xetvxoq4Pe",
"userSelected": true
}
],
"text": "rRRRM7W_3G"
},
"reason": [
{
"coding": [
{
"system": "ef89ozo1Y_",
"version": "EmzTXukEr2",
"code": "k92P3fXQQX",
"display": "AWWqTuq71C",
"userSelected": true
}
],
"text": "j3cMwZb6fZ"
}
],
"responsibleParty": [
{
"reference": "Practitioner/FV7Ik-Dkms",
"type": "Practitioner",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "BshHnZVOoW",
"version": "CivNLshQFm",
"code": "PQJTe4hP0J",
"display": "MaTLnuaBwc",
"userSelected": true
}
],
"text": "hdZBhKKMq0"
},
"system": "nxd9GAsA2P",
"value": "wlQj4aWP2X",
"period": {
"start": "2021-04-12T14:34:28.259-05:00",
"end": "2021-04-12T14:34:28.259-05:00"
}
},
"display": "y0sqiEn2JJ"
}
]
},
"detectedIssue": [
{
"reference": "DetectedIssue/MwiV5IZwCW",
"type": "DetectedIssue",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "cjx6srEZsE",
"version": "C2_e15sdkr",
"code": "vnIIlauYQ8",
"display": "uapS6K7pFs",
"userSelected": true
}
],
"text": "QX6NuDe119"
},
"system": "1SwP5Fh9wm",
"value": "UNIetYgxiX",
"period": {
"start": "2021-04-12T14:34:28.25-05:00",
"end": "2021-04-12T14:34:28.25-05:00"
}
},
"display": "GOCcqWBUMO"
}
],
"eventHistory": [
{
"reference": "Provenance/RbGKntpdPe",
"type": "Provenance",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "H37yaA4GbZ",
"version": "WsMmjXBLn0",
"code": "RXW8Xhn0na",
"display": "xTPcTqmOU0",
"userSelected": true
}
],
"text": "4Ybr1rEba6"
},
"system": "SyoVauMK7b",
"value": "CmNvU5KtLx",
"period": {
"start": "2021-04-12T14:34:28.262-05:00",
"end": "2021-04-12T14:34:28.262-05:00"
}
},
"display": "qBDF6Mt5Eh"
}
]
}
},
"MedicationDispense_Performer": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"function": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker."
},
"actor": {
"$ref": "#/components/schemas/Reference",
"description": "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication."
}
},
"required": [
"actor"
]
}
]
},
"MedicationDispense_Substitution": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"wasSubstituted": {
"type": "boolean",
"description": "True if the dispenser dispensed a different drug or product from what was prescribed."
},
"type": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A code signifying whether a different drug was dispensed from what was prescribed."
},
"reason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates the reason for the substitution (or lack of substitution) from what was prescribed."
}
},
"responsibleParty": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The person or organization that has primary responsibility for the substitution."
}
}
},
"required": [
"wasSubstituted"
]
}
]
},
"MedicationStatement": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server."
}
},
"basedOn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A plan, proposal or order that is fulfilled in whole or in part by this event."
}
},
"partOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "A larger event of which this particular event is a component or step."
}
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed."
},
"statusReason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Captures the reason for the current state of the MedicationStatement."
}
},
"category": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates where the medication is expected to be consumed or administered."
},
"medicationCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications."
},
"medicationReference": {
"$ref": "#/components/schemas/Reference",
"description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications."
},
"subject": {
"$ref": "#/components/schemas/Reference",
"description": "The person, animal or group who is/was taking the medication."
},
"context": {
"$ref": "#/components/schemas/Reference",
"description": "The encounter or episode of care that establishes the context for this MedicationStatement."
},
"effectiveDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No)."
},
"effectivePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No)."
},
"dateAsserted": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date when the medication statement was asserted by the information source."
},
"informationSource": {
"$ref": "#/components/schemas/Reference",
"description": "The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest."
},
"derivedFrom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement."
}
},
"reasonCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A reason for why the medication is being/was taken."
}
},
"reasonReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Condition or observation that supports why the medication is being/was taken."
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation",
"description": "Provides extra information about the medication statement that is not conveyed by the other attributes."
}
},
"dosage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dosage",
"description": "Indicates how the medication is/was or should be taken by the patient."
}
}
},
"required": [
"status",
"subject"
]
}
],
"example": {
"resourceType": "MedicationStatement",
"meta": {
"versionId": "UPtjXd-0UK",
"lastUpdated": "2021-04-12T14:34:35.594-05:00",
"source": "xkKLrvk7r7",
"profile": [
"wnBSAe4ov1"
],
"security": [
{
"system": "56KoNDCCZW",
"version": "F0ST9Whl2n",
"code": "JUVreBrDqn",
"display": "CcHwcvKiiS",
"userSelected": true
}
],
"tag": [
{
"system": "yuO4oHg9BP",
"version": "8uc4uO3ikj",
"code": "GDzI1m4jk1",
"display": "bNRNPgT9Se",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "QrAGhjc3qy",
"language": "en-US",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "secondary",
"type": {
"coding": [
{
"system": "MTZhu_Y9Lg",
"version": "wtqOsmZJmu",
"code": "e11GSiGO57",
"display": "TARCnMVxi4",
"userSelected": true
}
],
"text": "2Kr7whtRte"
},
"system": "VhSteJy2nK",
"value": "YEsMzIJG_8",
"period": {
"start": "2021-04-12T14:34:35.587-05:00",
"end": "2021-04-12T14:34:35.587-05:00"
}
}
],
"basedOn": [
{
"reference": "MedicationRequest/HMgmAtZpIt",
"type": "MedicationRequest",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "rioTznig5B",
"version": "WkTih_iv8a",
"code": "yV1CP3W7ty",
"display": "_IhO8NE7fI",
"userSelected": true
}
],
"text": "s2lSxzNyBP"
},
"system": "2yN8X7Ktjp",
"value": "AXZEUhdfJA",
"period": {
"start": "2021-04-12T14:34:35.587-05:00",
"end": "2021-04-12T14:34:35.587-05:00"
}
},
"display": "TA8aQukGnr"
}
],
"partOf": [
{
"reference": "MedicationAdministration/hkbstjahYz",
"type": "MedicationAdministration",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "WQKqG38pmQ",
"version": "x9FRUuIjIc",
"code": "QKJ_DPTDWB",
"display": "FY5G7gYGoz",
"userSelected": true
}
],
"text": "zIWkPtW_xX"
},
"system": "n23QeF5ogH",
"value": "z7pwMnR0D2",
"period": {
"start": "2021-04-12T14:34:35.585-05:00",
"end": "2021-04-12T14:34:35.585-05:00"
}
},
"display": "eYMt3EyHRO"
}
],
"status": "on-hold",
"statusReason": [
{
"coding": [
{
"system": "B2AvRor7p9",
"version": "PnX2K1aonC",
"code": "7XDCjjkqk5",
"display": "vZXdrjNaqV",
"userSelected": true
}
],
"text": "CPM8kHoLaD"
}
],
"category": {
"coding": [
{
"system": "4TxXSPbWJ6",
"version": "GcCljyUXIk",
"code": "wNubDmBcpP",
"display": "P72NOCFiXA",
"userSelected": true
}
],
"text": "ARDuk0eSVk"
},
"medicationCodeableConcept": {
"coding": [
{
"system": "GDlXZ1KcK4",
"version": "EUuSPHlYEm",
"code": "7TEf0GfbHd",
"display": "Ahb0Zz8iPX",
"userSelected": true
}
],
"text": "39Zjp06qdC"
},
"subject": {
"reference": "Patient/Le5EiK3jK4",
"type": "Patient",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "k1Q5hzAltR",
"version": "AvIZsZxI0l",
"code": "gEJtczxAj0",
"display": "yV3ItaeGsx",
"userSelected": true
}
],
"text": "v9rggox2vO"
},
"system": "AtTLNddi4q",
"value": "NwAUWZPbHU",
"period": {
"start": "2021-04-12T14:34:35.593-05:00",
"end": "2021-04-12T14:34:35.593-05:00"
}
},
"display": "hBmHRGlzyO"
},
"context": {
"reference": "Encounter/bsbaOLoegi",
"type": "Encounter",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "k85H4Q13tW",
"version": "JIfQr_6DrD",
"code": "cW9qkKoUoi",
"display": "XCEQnHryIa",
"userSelected": true
}
],
"text": "P6kXTrYsBg"
},
"system": "KkFkFGIjnw",
"value": "eR4P9tJU82",
"period": {
"start": "2021-04-12T14:34:35.593-05:00",
"end": "2021-04-12T14:34:35.593-05:00"
}
},
"display": "io0QuMZI1f"
},
"effectiveDateTime": "2021-04-12T14:34:35.593-05:00",
"dateAsserted": "2021-04-12T14:34:35.595-05:00",
"informationSource": {
"reference": "Patient/7rjKc7t4-s",
"type": "Patient",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "N9IKMav4v2",
"version": "zjDP9wBN45",
"code": "6UzR4YUQwu",
"display": "oVZovRogiw",
"userSelected": true
}
],
"text": "xHk5YWvWTa"
},
"system": "b7FDcnL8TY",
"value": "VGH3So8xGA",
"period": {
"start": "2021-04-12T14:34:35.594-05:00",
"end": "2021-04-12T14:34:35.594-05:00"
}
},
"display": "T40BP3G4ES"
},
"derivedFrom": [
{
"reference": "Basic/nSoFsvM64P",
"type": "Basic",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "tvLpH2dja8",
"version": "jN0J0ebaNX",
"code": "kilij9Mryd",
"display": "M436GxmXeW",
"userSelected": true
}
],
"text": "1jqNgMezi6"
},
"system": "is4__kcHIq",
"value": "Yakm9fRU8_",
"period": {
"start": "2021-04-12T14:34:35.588-05:00",
"end": "2021-04-12T14:34:35.588-05:00"
}
},
"display": "yCjnD1DlnJ"
}
],
"reasonCode": [
{
"coding": [
{
"system": "F51n7YcW2S",
"version": "OOLrhq1k5v",
"code": "YyTKF4rmoy",
"display": "HcGT4F6bnL",
"userSelected": true
}
],
"text": "u1HJMG5UGN"
}
],
"reasonReference": [
{
"reference": "Condition/34i8qDEKu4",
"type": "Condition",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "8DH3GtneRR",
"version": "23d21oY89w",
"code": "R9DIamJq3B",
"display": "iYccL1v_dv",
"userSelected": true
}
],
"text": "jDy6LLegbE"
},
"system": "ePgmFLg8TV",
"value": "hS0GvLH8XY",
"period": {
"start": "2021-04-12T14:34:35.586-05:00",
"end": "2021-04-12T14:34:35.586-05:00"
}
},
"display": "XqmFjmKt4W"
}
],
"note": [
{
"authorReference": {
"reference": "Practitioner/8837RxNpWc",
"type": "Practitioner",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "U5oWTWKi0j",
"version": "AqN4EJXkSR",
"code": "ZGInV5bz7N",
"display": "wmlXk3FG72",
"userSelected": true
}
],
"text": "130_5RP7QW"
},
"system": "_Qn6Ia2A0L",
"value": "G9vqZ9R96n",
"period": {
"start": "2021-04-12T14:34:35.592-05:00",
"end": "2021-04-12T14:34:35.592-05:00"
}
},
"display": "45lID77NL6"
},
"time": "2021-04-12T14:34:35.593-05:00",
"text": "MY3p3YKQXL"
}
],
"dosage": [
{
"sequence": 138894355,
"text": "YsWaO1zj7a",
"additionalInstruction": [
{
"coding": [
{
"system": "aRPjxTsyra",
"version": "gxdJhojG1U",
"code": "nJzii5xGdS",
"display": "YtrXjvzfUC",
"userSelected": true
}
],
"text": "SzFvCL8Kfj"
}
],
"patientInstruction": "WeUSZKE5EQ",
"timing": {
"event": [
"2021-04-12T14:34:35.589-05:00"
],
"repeat": {
"boundsDuration": {
"value": 301674750309,
"comparator": "<",
"unit": "ivjQG2a2b0",
"system": "http://unitsofmeasure.org",
"code": "h"
},
"count": 1802959719,
"countMax": 1307141117,
"duration": 373703930899,
"durationMax": 112868544307,
"durationUnit": "a",
"frequency": 642061941,
"frequencyMax": 1872802059,
"period": 502796988971,
"periodMax": 100697130872,
"periodUnit": "min",
"dayOfWeek": [
"fri"
],
"when": [
"PCM"
]
},
"code": {
"coding": [
{
"system": "qzIJe0Ue8i",
"version": "bNwDdz45ZA",
"code": "3ADwDiQKiu",
"display": "CCNyj8g25x",
"userSelected": true
}
],
"text": "l2aTdt2eGh"
}
},
"asNeededBoolean": true,
"site": {
"coding": [
{
"system": "6JxOE96An6",
"version": "kxeZtYOIEw",
"code": "o72l31pGfG",
"display": "yPglImEVNN",
"userSelected": true
}
],
"text": "qdYHzvRTNI"
},
"route": {
"coding": [
{
"system": "JvxoCQDB1K",
"version": "cQxChAB8Nx",
"code": "NZJXP52bSW",
"display": "wsiomiTaWt",
"userSelected": true
}
],
"text": "ZpkX5zp2bx"
},
"method": {
"coding": [
{
"system": "ItrJfpUoUG",
"version": "MufOnQZLuq",
"code": "_OJjm6B9AE",
"display": "HHB44AlV6Q",
"userSelected": true
}
],
"text": "S_xvh1XCSM"
},
"doseAndRate": [
{
"type": {
"coding": [
{
"system": "o_CfLNEQOx",
"version": "4UDmzK3IHA",
"code": "1e4QmHrZl1",
"display": "DFFoW1WyRG",
"userSelected": true
}
],
"text": "37OvhktCI_"
},
"doseRange": {
"low": {
"value": 73149319940,
"unit": "0UAk6p4HKN",
"system": "Z8sGJeLyOV",
"code": "Q62WHvEQYP"
}
},
"rateRatio": {
"numerator": {
"value": 61156122428,
"comparator": "<",
"unit": "zehrlH02WW",
"system": "n3NFRSouux",
"code": "JecemhWzht"
},
"denominator": {
"value": 13712762901,
"comparator": "<",
"unit": "QwRRmyKY59",
"system": "QcI8lYZ11_",
"code": "FNBSw_X0DE"
}
}
}
],
"maxDosePerPeriod": {
"numerator": {
"value": 344692758084,
"comparator": "<=",
"unit": "_jGo2BQVfx",
"system": "uFqeZBh8Wj",
"code": "o6fu_1B11Y"
},
"denominator": {
"value": 10191008058,
"comparator": ">",
"unit": "WQZsCx0ple",
"system": "I55NcrOKhD",
"code": "Cze06Ew_o7"
}
},
"maxDosePerAdministration": {
"value": 224468022081,
"unit": "bcdGU3FmvY",
"system": "MbkP64n3tK",
"code": "UKezWiTJtG"
},
"maxDosePerLifetime": {
"value": 172914314051,
"unit": "8NfQsKzfSr",
"system": "8U7BcqKEuf",
"code": "QexBNrTWHB"
}
}
]
}
},
"Organization": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Identifier for the organization that is used to identify the organization across multiple disparate systems."
}
},
"active": {
"type": "boolean",
"description": "Whether the organization's record is still in active use."
},
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The kind(s) of organization that this is."
}
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A name associated with the organization."
},
"alias": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A list of alternate names that the organization is known as, or was known as in the past."
}
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "A contact detail for the organization."
}
},
"address": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address",
"description": "An address for the organization."
}
},
"partOf": {
"$ref": "#/components/schemas/Reference",
"description": "The organization of which this organization forms a part."
},
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization_Contact",
"description": "Contact for the organization for a certain purpose."
}
},
"endpoint": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Technical endpoints providing access to services operated for the organization."
}
}
}
}
],
"example": {
"resourceType": "Organization",
"meta": {
"versionId": "ZM3fBQLPve",
"lastUpdated": "2021-04-12T14:34:34.598-05:00",
"source": "RMOaErAjyE",
"profile": [
"ILWkipRTAf"
],
"security": [
{
"system": "HCHedkuzMe",
"version": "id_qiwSxMu",
"code": "aSdsTtCBRn",
"display": "IW2TZU8XlV",
"userSelected": true
}
],
"tag": [
{
"system": "HmRWsQxcFP",
"version": "5RLgLmcEm4",
"code": "fdjnP_lsFv",
"display": "kk5LMLwB_K",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "4gx_Kea0ih",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "v447A477Tf",
"version": "jhqsgjWAEC",
"code": "KnCieu_R5w",
"display": "a3ykomQZDC",
"userSelected": true
}
],
"text": "S59rUFugg3"
},
"system": "7Ygf1CckXU",
"value": "jyeI49_oPF",
"period": {
"start": "2021-04-12T14:34:34.591-05:00",
"end": "2021-04-12T14:34:34.591-05:00"
}
}
],
"active": true,
"type": [
{
"coding": [
{
"system": "28yeDSsddz",
"version": "T1sUMkzmNR",
"code": "DpCr90Qaxl",
"display": "LsRNrxx8w6",
"userSelected": true
}
],
"text": "XrL2MovsP_"
}
],
"name": "Jso0LXlo1_",
"alias": [
"jmHK3FxZJ2"
],
"telecom": [
{
"system": "sms",
"value": "ZejoRXZftM",
"use": "work",
"rank": 66979848,
"period": {
"start": "2021-04-12T14:34:34.596-05:00",
"end": "2021-04-12T14:34:34.596-05:00"
}
}
],
"address": [
{
"use": "old",
"type": "both",
"text": "fHTmxK3JYL",
"line": [
"SdJFH1TB3T"
],
"city": "m_5eLtTq5h",
"district": "KZPozJXNsC",
"state": "7JF8D3vviE",
"postalCode": "6o2zA70_ZC",
"country": "40k8OVMbKW",
"period": {
"start": "2021-04-12T14:34:34.597-05:00",
"end": "2021-04-12T14:34:34.597-05:00"
}
}
],
"partOf": {
"reference": "Organization/Dt6W1QByIe",
"type": "Organization",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "frl1EQiEM2",
"version": "1ktXZ4hdWN",
"code": "8GLHkp9cEl",
"display": "MRi2xXQURp",
"userSelected": true
}
],
"text": "Z37StV2ysI"
},
"system": "PpcW0iI5Xo",
"value": "J4lHzIXlGK",
"period": {
"start": "2021-04-12T14:34:34.59-05:00",
"end": "2021-04-12T14:34:34.59-05:00"
}
},
"display": "bkeXJKV4KO"
},
"contact": [
{
"purpose": {
"coding": [
{
"system": "ayCPWLBkvU",
"version": "nUwtpO1Lwt",
"code": "55mQnQg634",
"display": "chFEcsQMAD",
"userSelected": true
}
],
"text": "27sGy1jYNS"
},
"name": {
"use": "nickname",
"text": "8Cb9RHZVUr",
"family": "AEaAuykHaH",
"given": [
"aoZI0CjgMh"
],
"prefix": [
"v4Y_SwusJF"
],
"suffix": [
"xBK7tRpLbl"
],
"period": {
"start": "2021-04-12T14:34:34.594-05:00",
"end": "2021-04-12T14:34:34.594-05:00"
}
},
"telecom": [
{
"system": "fax",
"value": "CJJ3VZ5l41",
"use": "old",
"rank": 1481221860,
"period": {
"start": "2021-04-12T14:34:34.594-05:00",
"end": "2021-04-12T14:34:34.594-05:00"
}
}
],
"address": {
"use": "old",
"type": "postal",
"text": "hg3zbHJwzF",
"line": [
"aUai5IZsPg"
],
"city": "ZqprxaEdIC",
"district": "fE3tVub9Ze",
"state": "GQmfp3w5Lu",
"postalCode": "CzzVEtgtc4",
"country": "qqoNnmc2gc",
"period": {
"start": "2021-04-12T14:34:34.595-05:00",
"end": "2021-04-12T14:34:34.595-05:00"
}
}
}
],
"endpoint": [
{
"reference": "Endpoint/RzzUpNHT7G",
"type": "Endpoint",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "iGBHKQrR6z",
"version": "plRSb3iaH1",
"code": "UUKBj71Ysp",
"display": "C3iC58Bhr3",
"userSelected": true
}
],
"text": "tlG956NNyd"
},
"system": "3nr9Q5HZ4c",
"value": "JnfLMPcLW0",
"period": {
"start": "2021-04-12T14:34:34.592-05:00",
"end": "2021-04-12T14:34:34.592-05:00"
}
},
"display": "tDluVPX08y"
}
]
}
},
"Organization_Contact": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"purpose": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Indicates a purpose for which the contact can be reached."
},
"name": {
"$ref": "#/components/schemas/HumanName",
"description": "A name associated with the contact."
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted."
}
},
"address": {
"$ref": "#/components/schemas/Address",
"description": "Visiting or postal addresses for the contact."
}
}
}
]
},
"Patient": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "An identifier for this patient."
}
},
"active": {
"type": "boolean",
"description": "Whether this patient record is in active use. \nMany systems use this property to mark as non–current patients, such as those that have not been seen for a period of time based on an organization's business rules.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death."
},
"name": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HumanName",
"description": "A name associated with the individual."
}
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted."
}
},
"gender": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Administrative Gender – the gender that the patient is considered to have for administration and record keeping purposes."
},
"birthDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The date of birth for the individual."
},
"deceasedBoolean": {
"type": "boolean",
"description": "Indicates if the individual is deceased or not."
},
"deceasedDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Indicates if the individual is deceased or not."
},
"address": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address",
"description": "An address for the individual."
}
},
"maritalStatus": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "This field contains a patient's most recent marital (civil) status."
},
"multipleBirthBoolean": {
"type": "boolean",
"description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer)."
},
"multipleBirthInteger": {
"type": "integer",
"format": "int32",
"description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer)."
},
"photo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment",
"description": "Image of the patient."
}
},
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Patient_Contact",
"description": "A contact party (e.g. guardian, partner, friend) for the patient."
}
},
"communication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Patient_Communication",
"description": "A language which may be used to communicate with the patient about his or her health."
}
},
"generalPractitioner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Patient's nominated care provider."
}
},
"managingOrganization": {
"$ref": "#/components/schemas/Reference",
"description": "Organization that is the custodian of the patient record."
},
"link": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Patient_Link",
"description": "Link to another patient resource that concerns the same actual patient."
}
}
}
}
],
"example": {
"resourceType": "Patient",
"meta": {
"versionId": "F0gRbtBoUD",
"lastUpdated": "2021-04-12T14:34:37.12-05:00",
"source": "tFFsHsdd7q",
"profile": [
"ab8SN4MdcO"
],
"security": [
{
"system": "SLCIUd2nfi",
"version": "iBt84hYx8b",
"code": "8pRTGoAegK",
"display": "PsPACdZkkY",
"userSelected": true
}
],
"tag": [
{
"system": "JqrrWijOqo",
"version": "suVAgESIm_",
"code": "6aAf1ugE47",
"display": "_kECbJ9WSp",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "9qjI4wXvPa",
"language": "en-US",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "UMJOSTawLJ",
"version": "_20Onq8KgN",
"code": "n98mxaAq82",
"display": "fJHMqkLVXr",
"userSelected": true
}
],
"text": "RI6pb39xAN"
},
"system": "YaMqEkl6vz",
"value": "gCYMbBlacd",
"period": {
"start": "2021-04-12T14:34:37.111-05:00",
"end": "2021-04-12T14:34:37.111-05:00"
}
}
],
"active": true,
"name": [
{
"use": "temp",
"text": "SfV70DxDHG",
"family": "YZpeXoZPBl",
"given": [
"ivw7wItGIK"
],
"prefix": [
"T1LBX7EVD5"
],
"suffix": [
"OX12_E6M28"
],
"period": {
"start": "2021-04-12T14:34:37.119-05:00",
"end": "2021-04-12T14:34:37.119-05:00"
}
}
],
"telecom": [
{
"system": "url",
"value": "goVNwYl6Yx",
"use": "mobile",
"rank": 1705811487,
"period": {
"start": "2021-04-12T14:34:37.117-05:00",
"end": "2021-04-12T14:34:37.117-05:00"
}
}
],
"gender": "other",
"birthDate": "2021-04-12",
"deceasedBoolean": true,
"address": [
{
"use": "temp",
"type": "postal",
"text": "vuZjCkwLGG",
"line": [
"lLtHfU73IM"
],
"city": "527k4OuHRU",
"district": "KyP5ANVD7c",
"state": "_1GBCRc3Oi",
"postalCode": "j5WSa_khWe",
"country": "LiWPoNYVBU",
"period": {
"start": "2021-04-12T14:34:37.119-05:00",
"end": "2021-04-12T14:34:37.119-05:00"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "Bj87Y7K8St",
"version": "QOWElO0AbA",
"code": "ABbRvqC7CC",
"display": "AfmSoFPkql",
"userSelected": true
}
],
"text": "mqyN44Y208"
},
"multipleBirthBoolean": true,
"photo": [
{
"contentType": "_zszYkieYn",
"language": "en-US",
"data": "ED4KRjM=",
"url": "U4X8o2HA7F",
"size": 628044503,
"hash": "Q2QYWH0=",
"title": "bB4coy9pwS",
"creation": "2021-04-12T14:34:37.109-05:00"
}
],
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "Lp0STdWcKj",
"version": "rtx_Yt8E1P",
"code": "ojcmkYXQqB",
"display": "mORS_DbkpB",
"userSelected": true
}
],
"text": "yNVUtROGJR"
}
],
"name": {
"use": "temp",
"text": "t3UQkJBMgZ",
"family": "WZWY_80XUW",
"given": [
"OXecDGkvhk"
],
"prefix": [
"jot2lJQEO0"
],
"suffix": [
"gZ8ocnIdna"
],
"period": {
"start": "2021-04-12T14:34:37.116-05:00",
"end": "2021-04-12T14:34:37.116-05:00"
}
},
"telecom": [
{
"system": "fax",
"value": "R3Ra6K03ZW",
"use": "temp",
"rank": 150296102,
"period": {
"start": "2021-04-12T14:34:37.116-05:00",
"end": "2021-04-12T14:34:37.116-05:00"
}
}
],
"address": {
"use": "work",
"type": "physical",
"text": "OfkEDaZhIR",
"line": [
"DUfNA9JuK9"
],
"city": "cZZNvRnTdb",
"district": "C7tBoyql6T",
"state": "vnd06rzF8P",
"postalCode": "1f8z_vSdVV",
"country": "JvObfRNKzo",
"period": {
"start": "2021-04-12T14:34:37.117-05:00",
"end": "2021-04-12T14:34:37.117-05:00"
}
},
"gender": "other",
"organization": {
"reference": "Organization/ZfXJ8f-biX",
"type": "Organization",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "7oGhXw1t9U",
"version": "xjvx0tRBXf",
"code": "l_alcJ_6zt",
"display": "PpiQAcgCTC",
"userSelected": true
}
],
"text": "1oyoNyBoKN"
},
"system": "q4Vq0cNRYY",
"value": "gdS2boboKH",
"period": {
"start": "2021-04-12T14:34:37.115-05:00",
"end": "2021-04-12T14:34:37.115-05:00"
}
},
"display": "t5Ak3lkJdn"
},
"period": {
"start": "2021-04-12T14:34:37.115-05:00",
"end": "2021-04-12T14:34:37.115-05:00"
}
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en-US"
}
]
},
"preferred": true
}
],
"generalPractitioner": [
{
"reference": "Organization/OXpnkSdiyt",
"type": "Organization",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "rkz1ju2WYH",
"version": "TmXeIV3_R9",
"code": "GlcCQxA9yB",
"display": "uL8fEug8W0",
"userSelected": true
}
],
"text": "bkmzT2gBpt"
},
"system": "QsL7ef_LkK",
"value": "GkBoEI5dsu",
"period": {
"start": "2021-04-12T14:34:37.121-05:00",
"end": "2021-04-12T14:34:37.121-05:00"
}
},
"display": "UWOfKvfG_8"
}
],
"managingOrganization": {
"reference": "Organization/oCN-XeXqdZ",
"type": "Organization",
"identifier": {
"use": "old",
"type": {
"coding": [
{
"system": "aQQN65QqT2",
"version": "VcM2Trm7l5",
"code": "cUwq6mCQ9A",
"display": "hHFq5WVDoy",
"userSelected": true
}
],
"text": "G_Qy5nVcsK"
},
"system": "AhDUZu9l0R",
"value": "5B2ZPnaCKk",
"period": {
"start": "2021-04-12T14:34:37.118-05:00",
"end": "2021-04-12T14:34:37.118-05:00"
}
},
"display": "tTpid5WLUu"
},
"link": [
{
"other": {
"reference": "Patient/ha39GeUTal",
"type": "Patient",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "hJDDJ3hxXc",
"version": "2m5YbsyjxD",
"code": "3CgUfhg4Au",
"display": "Is1dxrbAwt",
"userSelected": true
}
],
"text": "tKnP3utlIC"
},
"system": "BHPUYxoChh",
"value": "rUletMJa47",
"period": {
"start": "2021-04-12T14:34:37.112-05:00",
"end": "2021-04-12T14:34:37.112-05:00"
}
},
"display": "9xI6syRNDR"
},
"type": "seealso"
}
]
}
},
"Patient_Communication": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"language": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The ISO–639–1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO–3166–1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en–US\" for American English versus \"en–EN\" for England English."
},
"preferred": {
"type": "boolean",
"description": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level)."
}
},
"required": [
"language"
]
}
]
},
"Patient_Contact": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"relationship": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The nature of the relationship between the patient and the contact person."
}
},
"name": {
"$ref": "#/components/schemas/HumanName",
"description": "A name associated with the contact person."
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "A contact detail for the person, e.g. a telephone number or an email address."
}
},
"address": {
"$ref": "#/components/schemas/Address",
"description": "Address for the contact person."
},
"gender": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Administrative Gender – the gender that the contact person is considered to have for administration and record keeping purposes."
},
"organization": {
"$ref": "#/components/schemas/Reference",
"description": "Organization on behalf of which the contact is acting or for which the contact is working."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The period during which this contact person or organization is valid to be contacted relating to this patient."
}
}
}
]
},
"Patient_Link": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"other": {
"$ref": "#/components/schemas/Reference",
"description": "The other patient resource that the link refers to."
},
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The type of link between this patient resource and another patient resource."
}
},
"required": [
"other",
"type"
]
}
]
},
"Practitioner": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "An identifier that applies to this person in this role."
}
},
"active": {
"type": "boolean",
"description": "Whether this practitioner's record is in active use."
},
"name": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HumanName",
"description": "The name(s) associated with the practitioner."
}
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "A contact detail for the practitioner, e.g. a telephone number or an email address."
}
},
"address": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address",
"description": "Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent."
}
},
"gender": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Administrative Gender – the gender that the person is considered to have for administration and record keeping purposes."
},
"birthDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The date of birth for the practitioner."
},
"photo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment",
"description": "Image of the person."
}
},
"qualification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Practitioner_Qualification",
"description": "The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality."
}
},
"communication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A language the practitioner can use in patient communication."
}
}
}
}
],
"example": {
"resourceType": "Practitioner",
"meta": {
"versionId": "MMfJpwFyD3",
"lastUpdated": "2021-04-12T14:34:34.372-05:00",
"source": "HzHFfk2R0E",
"profile": [
"pU7AzjAZyX"
],
"security": [
{
"system": "lVqVaUwOoo",
"version": "FCK1K0WUJm",
"code": "flOrLgsF3t",
"display": "N8J3DH8UxH",
"userSelected": true
}
],
"tag": [
{
"system": "kakWWOGreA",
"version": "UOxXXND_CY",
"code": "_RYMNiwSUS",
"display": "9URNpd36Sm",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "Qrd5N98TZq",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "9Gauggvfwk",
"version": "3pipA1k6pn",
"code": "EnMuV_Wfwn",
"display": "BRQ0TDwrcL",
"userSelected": true
}
],
"text": "lMuU1752CP"
},
"system": "mXNBaYSZVD",
"value": "OL2lefjYCT",
"period": {
"start": "2021-04-12T14:34:34.365-05:00",
"end": "2021-04-12T14:34:34.365-05:00"
}
}
],
"active": true,
"name": [
{
"use": "usual",
"text": "hTXHPtZf6N",
"family": "Sx0SuaR4dO",
"given": [
"Ng0lTC8NaH"
],
"prefix": [
"lH2vo_sTq5"
],
"suffix": [
"lqT1BPvQ8R"
],
"period": {
"start": "2021-04-12T14:34:34.37-05:00",
"end": "2021-04-12T14:34:34.371-05:00"
}
}
],
"telecom": [
{
"system": "other",
"value": "oS8VodV61R",
"use": "old",
"rank": 64078089,
"period": {
"start": "2021-04-12T14:34:34.368-05:00",
"end": "2021-04-12T14:34:34.368-05:00"
}
}
],
"address": [
{
"use": "billing",
"type": "both",
"text": "A0ZKGZ8oCu",
"line": [
"O5s1tH7Z3B"
],
"city": "4v6R4aXWZZ",
"district": "h47uLIAafi",
"state": "0ZvEKLTtA5",
"postalCode": "LOEvssJY5R",
"country": "w3j5fOEP1z",
"period": {
"start": "2021-04-12T14:34:34.371-05:00",
"end": "2021-04-12T14:34:34.371-05:00"
}
}
],
"gender": "female",
"birthDate": "2021-04-12",
"photo": [
{
"contentType": "sQGe1hkZ8Y",
"language": "en-US",
"data": "VDY6C0Y=",
"url": "UqgTm625pv",
"size": 1933338089,
"hash": "AUUVMhQ=",
"title": "kpyxqLI6ZS",
"creation": "2021-04-12T14:34:34.364-05:00"
}
],
"qualification": [
{
"identifier": [
{
"use": "old",
"type": {
"coding": [
{
"system": "S3RH26fyLh",
"version": "7Y9NyX4xRr",
"code": "rqFLMXwyfE",
"display": "MljZ4hfXbX",
"userSelected": true
}
],
"text": "ux7jnsmfS1"
},
"system": "ZYGQUjFnqR",
"value": "bbQs4HGXWX",
"period": {
"start": "2021-04-12T14:34:34.367-05:00",
"end": "2021-04-12T14:34:34.367-05:00"
}
}
],
"code": {
"coding": [
{
"system": "GOmWpBbZma",
"version": "PyNn4U8umX",
"code": "Va1S4B_dM1",
"display": "Fe1tuK8MfN",
"userSelected": true
}
],
"text": "9Zh5mSZGX1"
},
"period": {
"start": "2021-04-12T14:34:34.366-05:00",
"end": "2021-04-12T14:34:34.367-05:00"
},
"issuer": {
"reference": "Organization/pM1KeOsJrA",
"type": "Organization",
"identifier": {
"use": "official",
"type": {
"coding": [
{
"system": "5Vy8nelgEL",
"version": "2nX3NP1H20",
"code": "t4LiUitYg5",
"display": "qRvJ8dYkco",
"userSelected": true
}
],
"text": "aqUL4FJ9cf"
},
"system": "CGwncY0ss4",
"value": "A7gOFtg7nx",
"period": {
"start": "2021-04-12T14:34:34.368-05:00",
"end": "2021-04-12T14:34:34.368-05:00"
}
},
"display": "KehrJgcdID"
}
}
],
"communication": [
{
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en-US"
}
]
}
]
}
},
"Practitioner_Qualification": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "An identifier that applies to this person's qualification in this role."
}
},
"code": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Coded representation of the qualification."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "Period during which the qualification is valid."
},
"issuer": {
"$ref": "#/components/schemas/Reference",
"description": "Organization that regulates and issues the qualification."
}
},
"required": [
"code"
]
}
]
},
"PractitionerRole": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "Business Identifiers that are specific to a role/location."
}
},
"active": {
"type": "boolean",
"description": "Whether this practitioner role record is in active use."
},
"period": {
"$ref": "#/components/schemas/Period",
"description": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization."
},
"practitioner": {
"$ref": "#/components/schemas/Reference",
"description": "Practitioner that is able to provide the defined services for the organization."
},
"organization": {
"$ref": "#/components/schemas/Reference",
"description": "The organization where the Practitioner performs the roles associated."
},
"code": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Roles which this practitioner is authorized to perform for the organization."
}
},
"specialty": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Specific specialty of the practitioner."
}
},
"location": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The location(s) at which this practitioner provides care."
}
},
"healthcareService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)."
}
},
"telecom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPoint",
"description": "Contact details that are specific to the role/location/service."
}
},
"availableTime": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerRole_AvailableTime",
"description": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice."
}
},
"notAvailable": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerRole_NotAvailable",
"description": "The practitioner is not available or performing this role during this period of time due to the provided reason."
}
},
"availabilityExceptions": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times."
},
"endpoint": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference",
"description": "Technical endpoints providing access to services operated for the practitioner with this role."
}
}
}
}
],
"example": {
"resourceType": "PractitionerRole",
"meta": {
"versionId": "CqNrWoA4v1",
"lastUpdated": "2021-04-12T14:34:36.302-05:00",
"source": "l4_yoDppgJ",
"profile": [
"FauVKFJuYl"
],
"security": [
{
"system": "3YyH7KP46v",
"version": "ixO_RhEzGo",
"code": "NSrYAu649D",
"display": "jR7XXbkanI",
"userSelected": true
}
],
"tag": [
{
"system": "YP83LlwXb0",
"version": "4aaE5yL3PX",
"code": "SIZsWBR68T",
"display": "eGhGbil6LU",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "7yAERhW0WF",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"identifier": [
{
"use": "temp",
"type": {
"coding": [
{
"system": "CytCIiSrq_",
"version": "hMosmFWM0d",
"code": "E2BDrRktwf",
"display": "drgGf8ZFMW",
"userSelected": true
}
],
"text": "LDOkBS1v4T"
},
"system": "bhkuIlnpw5",
"value": "YbJruIUTKG",
"period": {
"start": "2021-04-12T14:34:36.296-05:00",
"end": "2021-04-12T14:34:36.296-05:00"
}
}
],
"active": true,
"period": {
"start": "2021-04-12T14:34:36.296-05:00",
"end": "2021-04-12T14:34:36.296-05:00"
},
"practitioner": {
"reference": "Practitioner/FWb7mG5jz1",
"type": "Practitioner",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "lIiURCkuRy",
"version": "eHdSsOvB2h",
"code": "rjHaKAwUnV",
"display": "uUdQNqIKT0",
"userSelected": true
}
],
"text": "QPB9NqlsLM"
},
"system": "rdexad9p8C",
"value": "RdpwICxy2a",
"period": {
"start": "2021-04-12T14:34:36.298-05:00",
"end": "2021-04-12T14:34:36.298-05:00"
}
},
"display": "sBG5i4sPaL"
},
"organization": {
"reference": "Organization/MWjKmcuThQ",
"type": "Organization",
"identifier": {
"use": "secondary",
"type": {
"coding": [
{
"system": "_tPYl8DXR0",
"version": "B6D6rY6elh",
"code": "axMZ8xdzit",
"display": "mzZTNh4LkZ",
"userSelected": true
}
],
"text": "kPN8iTrvkr"
},
"system": "9fZX33esgs",
"value": "5i4p9ZaVj7",
"period": {
"start": "2021-04-12T14:34:36.299-05:00",
"end": "2021-04-12T14:34:36.299-05:00"
}
},
"display": "mcv53Lai_C"
},
"code": [
{
"coding": [
{
"system": "NAozA0OquV",
"version": "fDZn88T0_h",
"code": "Hx6a5bmbci",
"display": "F7MeoynY55",
"userSelected": true
}
],
"text": "mRj1_DyHAv"
}
],
"specialty": [
{
"coding": [
{
"system": "3lvc49NeZe",
"version": "a1TS8SwKUH",
"code": "g_RXz2nXqi",
"display": "pqy5gMyOZV",
"userSelected": true
}
],
"text": "3I10DfhMMJ"
}
],
"location": [
{
"reference": "Location/fBR7UCFwcO",
"type": "Location",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "iQWDsvnlpP",
"version": "x6RKOCr5o_",
"code": "Mu3mfdSrTk",
"display": "WitMecLfgf",
"userSelected": true
}
],
"text": "gZ2lgXHLM5"
},
"system": "GJqOVSGFut",
"value": "kw6gP8WArd",
"period": {
"start": "2021-04-12T14:34:36.3-05:00",
"end": "2021-04-12T14:34:36.301-05:00"
}
},
"display": "_bo2pEVhFM"
}
],
"healthcareService": [
{
"reference": "HealthcareService/W-3nqQsyp8",
"type": "HealthcareService",
"identifier": {
"use": "usual",
"type": {
"coding": [
{
"system": "ftteBlNquE",
"version": "VsKmoKUsNs",
"code": "bJs34MaF67",
"display": "L31sKptnk2",
"userSelected": true
}
],
"text": "olaDK71e8s"
},
"system": "n00Yz1rEkT",
"value": "b_ahmiTHP8",
"period": {
"start": "2021-04-12T14:34:36.297-05:00",
"end": "2021-04-12T14:34:36.297-05:00"
}
},
"display": "ha3JtLSqnF"
}
],
"telecom": [
{
"system": "sms",
"value": "uqn6I6zb8p",
"use": "mobile",
"rank": 1259568725,
"period": {
"start": "2021-04-12T14:34:36.299-05:00",
"end": "2021-04-12T14:34:36.299-05:00"
}
}
],
"availableTime": [
{
"daysOfWeek": [
"sat"
],
"allDay": true,
"availableStartTime": "14:34:36.294",
"availableEndTime": "14:34:36.295"
}
],
"notAvailable": [
{
"description": "oBmL4qunaC",
"during": {
"start": "2021-04-12T14:34:36.295-05:00",
"end": "2021-04-12T14:34:36.295-05:00"
}
}
],
"availabilityExceptions": "e_abSPBG0Z",
"endpoint": [
{
"reference": "Endpoint/s9h-WN6Drj",
"type": "Endpoint",
"identifier": {
"use": "temp",
"type": {
"coding": [
{
"system": "acFmYTIafO",
"version": "bC3Uz3elra",
"code": "oAcBoEWJbx",
"display": "qvoncXOANP",
"userSelected": true
}
],
"text": "on4N3UB8oA"
},
"system": "MD6eMh0ovy",
"value": "0rmG6FfL0D",
"period": {
"start": "2021-04-12T14:34:36.297-05:00",
"end": "2021-04-12T14:34:36.297-05:00"
}
},
"display": "_zlgslj0KL"
}
]
}
},
"PractitionerRole_AvailableTime": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"daysOfWeek": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates which days of the week are available between the start and end Times."
}
},
"allDay": {
"type": "boolean",
"description": "Is this always available? (hence times are irrelevant) e.g. 24 hour service."
},
"availableStartTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored."
},
"availableEndTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored."
}
}
}
]
},
"PractitionerRole_NotAvailable": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The reason that can be presented to the user as to why this time is not available."
},
"during": {
"$ref": "#/components/schemas/Period",
"description": "Service is not available (seasonally or for a public holiday) from this date."
}
},
"required": [
"description"
]
}
]
},
"StructureDefinition": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers."
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance."
}
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation."
},
"title": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A short, descriptive, user–friendly title for the structure definition."
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of this structure definition. Enables tracking the life–cycle of the content."
},
"experimental": {
"type": "boolean",
"description": "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes."
},
"publisher": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the organization or individual that published the structure definition."
},
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactDetail",
"description": "Contact details to assist a user in finding and communicating with the publisher."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A free text natural language description of the structure definition from a consumer's perspective."
},
"useContext": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageContext",
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances."
}
},
"jurisdiction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A legal or geographic region in which the structure definition is intended to be used."
}
},
"purpose": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Explanation of why this structure definition is needed and why it has been designed as it has."
},
"copyright": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition."
},
"keyword": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes."
}
},
"fhirVersion": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The version of the FHIR specification on which this StructureDefinition is based – this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.0. for this version."
},
"mapping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StructureDefinition_Mapping",
"description": "An external specification that the content is mapped to."
}
},
"kind": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Defines the kind of structure that this definition is describing."
},
"abstract": {
"type": "boolean",
"description": "Whether structure this definition describes is abstract or not – that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems."
},
"context": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StructureDefinition_Context",
"description": "Identifies the types of resource or data type elements to which the extension can be applied."
}
},
"contextInvariant": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co–occurrence variants for the extension). All the rules must be true."
}
},
"type": {
"type": "string",
"pattern": "\\S*",
"description": "Defines how to interpret the expression that defines what the context of the extension is."
},
"baseDefinition": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint."
},
"derivation": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "How the type relates to the baseDefinition."
},
"snapshot": {
"$ref": "#/components/schemas/StructureDefinition_Snapshot",
"description": "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition."
},
"differential": {
"$ref": "#/components/schemas/StructureDefinition_Differential",
"description": "A differential view is expressed relative to the base StructureDefinition – a statement of differences that it applies."
}
},
"required": [
"url",
"name",
"status",
"kind",
"abstract",
"type"
]
}
],
"example": {
"resourceType": "StructureDefinition",
"meta": {
"versionId": "QiFCGOry9x",
"lastUpdated": "2021-04-12T14:34:29.22-05:00",
"source": "oQVGW33_ig",
"profile": [
"tvERLO7Tcz"
],
"security": [
{
"system": "thAXTzjvQ6",
"version": "wzpmd8T1HK",
"code": "z6r_WERlzy",
"display": "iiP9trbgP1",
"userSelected": true
}
],
"tag": [
{
"system": "JQmDWzzjSq",
"version": "5Qq7T5Q3_D",
"code": "Rjy1Jsqdjr",
"display": "wuCM4v8kto",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "UJgETVWW2j",
"language": "en-US",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"url": "C9gQOAcutY",
"identifier": [
{
"use": "temp",
"type": {
"coding": [
{
"system": "G_HSH6eBIU",
"version": "LiLR88mjbN",
"code": "r32I1qK_Hx",
"display": "sm_KxewDuD",
"userSelected": true
}
],
"text": "iOriUocmuw"
},
"system": "EIRbGU1hcI",
"value": "MA9lxgZJn9",
"period": {
"start": "2021-04-12T14:34:29.212-05:00",
"end": "2021-04-12T14:34:29.212-05:00"
}
}
],
"version": "59JUXisC4T",
"name": "86lN4iKbHj",
"title": "SiuFL5ULBW",
"status": "unknown",
"experimental": true,
"date": "2021-04-12T14:34:29.219-05:00",
"publisher": "tizgMq7D02",
"contact": [
{
"name": "5bge2WOtXr",
"telecom": [
{
"system": "fax",
"value": "HG0ZftR9XS",
"use": "temp",
"rank": 718899580,
"period": {
"start": "2021-04-12T14:34:29.216-05:00",
"end": "2021-04-12T14:34:29.216-05:00"
}
}
]
}
],
"description": "CkiF7x7pFn",
"useContext": [
{
"code": {
"system": "2nHWWCVYbF",
"version": "DgoPMlEe6f",
"code": "8Ndg4d42IL",
"display": "U82EsXGWSu",
"userSelected": true
},
"valueCodeableConcept": {
"coding": [
{
"system": "Hpv9Hhfdtn",
"version": "PCTJLNZAwP",
"code": "ZYVCF6gIM9",
"display": "mxvYiGN2fZ",
"userSelected": true
}
],
"text": "sjePJx9Wlc"
}
}
],
"jurisdiction": [
{
"coding": [
{
"system": "i3havUlg0V",
"version": "sCQ4aqiQNF",
"code": "8ivoypWo7n",
"display": "RIo_q6krjA",
"userSelected": true
}
],
"text": "CWVV0KgNmx"
}
],
"purpose": "EUXpqOl9Hn",
"copyright": "kJupBohH9d",
"keyword": [
{
"system": "5gEVAjybFk",
"version": "OVLzv77Nil",
"code": "HVub5tGvhz",
"display": "q5HuNms70T",
"userSelected": true
}
],
"fhirVersion": "0.0.80",
"mapping": [
{
"identity": "faH5TogxF6",
"uri": "KgFbntxq5X",
"name": "awFLoVM7B8",
"comment": "3Lyusay74n"
}
],
"kind": "primitive-type",
"abstract": true,
"context": [
{
"type": "element",
"expression": "CqQ9l7Cpyq"
}
],
"contextInvariant": [
"kCk8OIYJC3"
],
"type": "0sJ_9JCHar",
"baseDefinition": "oaHTwzRecG",
"derivation": "constraint",
"snapshot": {
"element": [
{
"path": "Np6iTbBFPO",
"representation": [
"xmlAttr"
],
"sliceName": "pNdtTMYVwN",
"sliceIsConstraining": true,
"label": "QrFXIMHqJ1",
"code": [
{
"system": "afR_jCJDLl",
"version": "AfgQ9GQKzV",
"code": "CAEtfp1UIU",
"display": "acAzaOKBlK",
"userSelected": true
}
],
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "z71jj0hejM"
}
],
"description": "g6kfHXrX6O",
"ordered": true,
"rules": "closed"
},
"short": "l7Ia4BrV8v",
"definition": "QpFDDZj_nV",
"comment": "C3RBBtnjp6",
"requirements": "lgZYwtS0Xw",
"alias": [
"5bf7pcVi3Z"
],
"min": 833006962,
"max": "Y9EIh5ACaO",
"base": {
"path": "iBxSO8sH7h",
"min": 755363702,
"max": "74nhweW1mZ"
},
"contentReference": "tI9DTIkEDy",
"type": [
{
"code": "zMJ_SwsOIR",
"profile": [
"NUNEqqUgDI"
],
"targetProfile": [
"wLaJGuZSfM"
],
"aggregation": [
"bundled"
],
"versioning": "specific"
}
],
"defaultValueBase64Binary": "KQxCEwY=",
"meaningWhenMissing": "KqpoFMQL0K",
"orderMeaning": "sHK1Pt2ZcI",
"fixedBase64Binary": "Twp+agQ=",
"patternBase64Binary": "LS05X1U=",
"example": [
{
"label": "Z77u8amUJz",
"valueBase64Binary": "fwwWKAY="
}
],
"minValueDate": "2021-04-12",
"maxValueDate": "2021-04-12",
"maxLength": 507301669,
"condition": [
"90u94KhK23"
],
"constraint": [
{
"key": "gpYUx1MIBz",
"requirements": "zG1wu7esBS",
"severity": "warning",
"human": "oTzzLVQLRm",
"expression": "4PV8fcN6ll",
"xpath": "KMmjTRnzbG",
"source": "AVRJtCvaAI"
}
],
"mustSupport": true,
"isModifier": true,
"isModifierReason": "zfUeEhx6T2",
"isSummary": true,
"binding": {
"strength": "example",
"description": "aALrXj7prc",
"valueSet": "m5iKRguEtB"
},
"mapping": [
{
"identity": "JECjor1YWI",
"language": "riL4hZLRwv",
"map": "y826Iq3tas",
"comment": "bQGsrxfZ5C"
}
]
}
]
},
"differential": {
"element": [
{
"path": "4gyX5s4kbM",
"representation": [
"xmlText"
],
"sliceName": "dA9UxZ5pwO",
"sliceIsConstraining": true,
"label": "Kw1FlTf2P0",
"code": [
{
"system": "awB9xWd1Bv",
"version": "TfNh6_FNoL",
"code": "nEGZkrESxm",
"display": "DAve8_UzR6",
"userSelected": true
}
],
"slicing": {
"discriminator": [
{
"type": "value",
"path": "XcesQTna71"
}
],
"description": "31xlrE85da",
"ordered": true,
"rules": "open"
},
"short": "HfwNE3Fm1i",
"definition": "d_8Ts3wUoN",
"comment": "y1_bfmfba4",
"requirements": "hiGrhZF7Zk",
"alias": [
"Su9ioYLDNf"
],
"min": 1392247272,
"max": "7jcsNGb915",
"base": {
"path": "idtvdAZwSM",
"min": 1696998391,
"max": "Oyyn0l17m8"
},
"contentReference": "gqjFcCaGYO",
"type": [
{
"code": "5BLr78SrVB",
"profile": [
"qv0Ic42cx5"
],
"targetProfile": [
"9U7_AUVurz"
],
"aggregation": [
"contained"
],
"versioning": "independent"
}
],
"defaultValueBase64Binary": "b0ANQn8=",
"meaningWhenMissing": "NzoI_zZUl8",
"orderMeaning": "1PZtBbDDVz",
"fixedBase64Binary": "bVhBdD0=",
"patternBase64Binary": "BSg/K0s=",
"example": [
{
"label": "arh5aBDIXs",
"valueBase64Binary": "GGNVKh0="
}
],
"minValueDate": "2021-04-12",
"maxValueDate": "2021-04-12",
"maxLength": 1856725075,
"condition": [
"UEKpBuVV-V"
],
"constraint": [
{
"key": "8ZegbFEL2T",
"requirements": "Opkc4jxT6S",
"severity": "error",
"human": "Iq6rbQwURv",
"expression": "sigxr_ysIF",
"xpath": "wXG7Qn08qV",
"source": "wowvuEXLL2"
}
],
"mustSupport": true,
"isModifier": true,
"isModifierReason": "3hoVuZTxnd",
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "V_bH6tKnMh",
"valueSet": "tNK5Z8CGVx"
},
"mapping": [
{
"identity": "EDFcm8LRUT",
"language": "LOlvbGzS7C",
"map": "edrsdldylY",
"comment": "6fNp8hpfdV"
}
]
}
]
}
}
},
"StructureDefinition_Context": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Defines how to interpret the expression that defines what the context of the extension is."
},
"expression": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "An expression that defines where an extension can be used in resources."
}
},
"required": [
"type",
"expression"
]
}
]
},
"StructureDefinition_Differential": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"element": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementDefinition",
"description": "Captures constraints on each element within the resource."
},
"minItems": 1
}
},
"required": [
"element"
]
}
]
},
"StructureDefinition_Mapping": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"identity": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "An Internal id that is used to identify this mapping set when specific mappings are made."
},
"uri": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI that identifies the specification that this mapping is expressed to."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A name for the specification that is being mapped to."
},
"comment": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage."
}
},
"required": [
"identity"
]
}
]
},
"StructureDefinition_Snapshot": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"element": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementDefinition",
"description": "Captures constraints on each element within the resource."
},
"minItems": 1
}
},
"required": [
"element"
]
}
]
},
"ElementDefinition": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"path": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The path identifies the element and is expressed as a \".\"–separated list of ancestor elements, beginning with the name of the resource or extension."
},
"representation": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Codes that define how this element is represented in instances, when the deviation varies from the normal case."
}
},
"sliceName": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element."
},
"sliceIsConstraining": {
"type": "boolean",
"description": "If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName."
},
"label": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form."
},
"code": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding",
"description": "A code that has the same meaning as the element in a particular terminology."
}
},
"slicing": {
"$ref": "#/components/schemas/ElementDefinition_Slicing",
"description": "Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set)."
},
"short": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A concise description of what this element means (e.g. for use in autogenerated summaries)."
},
"definition": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition)."
},
"comment": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment)."
},
"requirements": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element."
},
"alias": {
"type": "array",
"items": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Identifies additional names by which this element might also be known."
}
},
"min": {
"type": "integer",
"format": "int32",
"description": "The minimum number of times this element SHALL appear in the instance."
},
"max": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The maximum number of times this element is permitted to appear in the instance."
},
"base": {
"$ref": "#/components/schemas/ElementDefinition_Base",
"description": "Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element – i.g. either in a constraint on another type, or for elements from a super type in a snap shot – then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same."
},
"contentReference": {
"type": "string",
"pattern": "\\S*",
"description": "Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc."
},
"type": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementDefinition_Type",
"description": "How the element value is interpreted when discrimination is evaluated."
},
"minItems": 1
},
"defaultValueBase64Binary": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueBoolean": {
"type": "boolean",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueCanonical": {
"type": "string",
"pattern": "\\S*",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueDecimal": {
"type": "number",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueId": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueInteger": {
"type": "integer",
"format": "int32",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueMarkdown": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueOid": {
"type": "string",
"pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValuePositiveInt": {
"type": "integer",
"format": "int32",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueUri": {
"type": "string",
"pattern": "\\S*",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueUrl": {
"type": "string",
"pattern": "\\S*",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueUuid": {
"type": "string",
"pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueAddress": {
"$ref": "#/components/schemas/Address",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueAge": {
"$ref": "#/components/schemas/Age",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueAnnotation": {
"$ref": "#/components/schemas/Annotation",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueCoding": {
"$ref": "#/components/schemas/Coding",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueContactPoint": {
"$ref": "#/components/schemas/ContactPoint",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueCount": {
"$ref": "#/components/schemas/Count",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueDistance": {
"$ref": "#/components/schemas/Distance",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueDuration": {
"$ref": "#/components/schemas/Duration",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueHumanName": {
"$ref": "#/components/schemas/HumanName",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueMoney": {
"$ref": "#/components/schemas/Money",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValuePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueRange": {
"$ref": "#/components/schemas/Range",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueReference": {
"$ref": "#/components/schemas/Reference",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueSignature": {
"$ref": "#/components/schemas/Signature",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueTiming": {
"$ref": "#/components/schemas/Timing",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueContactDetail": {
"$ref": "#/components/schemas/ContactDetail",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueRelatedArtifact": {
"$ref": "#/components/schemas/RelatedArtifact",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueUsageContext": {
"$ref": "#/components/schemas/UsageContext",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"defaultValueMeta": {
"$ref": "#/components/schemas/Meta",
"description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')."
},
"meaningWhenMissing": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing')."
},
"orderMeaning": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning."
},
"fixedBase64Binary": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedBoolean": {
"type": "boolean",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedCanonical": {
"type": "string",
"pattern": "\\S*",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedDecimal": {
"type": "number",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedId": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedInteger": {
"type": "integer",
"format": "int32",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedMarkdown": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedOid": {
"type": "string",
"pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedPositiveInt": {
"type": "integer",
"format": "int32",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedUri": {
"type": "string",
"pattern": "\\S*",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedUrl": {
"type": "string",
"pattern": "\\S*",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedUuid": {
"type": "string",
"pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedAddress": {
"$ref": "#/components/schemas/Address",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedAge": {
"$ref": "#/components/schemas/Age",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedAnnotation": {
"$ref": "#/components/schemas/Annotation",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedCoding": {
"$ref": "#/components/schemas/Coding",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedContactPoint": {
"$ref": "#/components/schemas/ContactPoint",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedCount": {
"$ref": "#/components/schemas/Count",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedDistance": {
"$ref": "#/components/schemas/Distance",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedDuration": {
"$ref": "#/components/schemas/Duration",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedHumanName": {
"$ref": "#/components/schemas/HumanName",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedMoney": {
"$ref": "#/components/schemas/Money",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedRange": {
"$ref": "#/components/schemas/Range",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedReference": {
"$ref": "#/components/schemas/Reference",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedSignature": {
"$ref": "#/components/schemas/Signature",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedTiming": {
"$ref": "#/components/schemas/Timing",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedContactDetail": {
"$ref": "#/components/schemas/ContactDetail",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedRelatedArtifact": {
"$ref": "#/components/schemas/RelatedArtifact",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedUsageContext": {
"$ref": "#/components/schemas/UsageContext",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"fixedMeta": {
"$ref": "#/components/schemas/Meta",
"description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non–significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing."
},
"patternBase64Binary": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternBoolean": {
"type": "boolean",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternCanonical": {
"type": "string",
"pattern": "\\S*",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternDecimal": {
"type": "number",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternId": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternInteger": {
"type": "integer",
"format": "int32",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternMarkdown": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternOid": {
"type": "string",
"pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternPositiveInt": {
"type": "integer",
"format": "int32",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternUri": {
"type": "string",
"pattern": "\\S*",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternUrl": {
"type": "string",
"pattern": "\\S*",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternUuid": {
"type": "string",
"pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternAddress": {
"$ref": "#/components/schemas/Address",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternAge": {
"$ref": "#/components/schemas/Age",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternAnnotation": {
"$ref": "#/components/schemas/Annotation",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternCoding": {
"$ref": "#/components/schemas/Coding",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternContactPoint": {
"$ref": "#/components/schemas/ContactPoint",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternCount": {
"$ref": "#/components/schemas/Count",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternDistance": {
"$ref": "#/components/schemas/Distance",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternDuration": {
"$ref": "#/components/schemas/Duration",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternHumanName": {
"$ref": "#/components/schemas/HumanName",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternMoney": {
"$ref": "#/components/schemas/Money",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternPeriod": {
"$ref": "#/components/schemas/Period",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternRange": {
"$ref": "#/components/schemas/Range",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternReference": {
"$ref": "#/components/schemas/Reference",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternSignature": {
"$ref": "#/components/schemas/Signature",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternTiming": {
"$ref": "#/components/schemas/Timing",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternContactDetail": {
"$ref": "#/components/schemas/ContactDetail",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternRelatedArtifact": {
"$ref": "#/components/schemas/RelatedArtifact",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternUsageContext": {
"$ref": "#/components/schemas/UsageContext",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"patternMeta": {
"$ref": "#/components/schemas/Meta",
"description": "Specifies a value that the value in the instance SHALL follow – that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match –– i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value."
},
"example": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementDefinition_Example",
"description": "A sample value for this element demonstrating the type of information that would typically be found in the element."
}
},
"minValueDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValueInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValueDecimal": {
"type": "number",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValueInteger": {
"type": "integer",
"format": "int32",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValuePositiveInt": {
"type": "integer",
"format": "int32",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValueUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"minValueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueDecimal": {
"type": "number",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueInteger": {
"type": "integer",
"format": "int32",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValuePositiveInt": {
"type": "integer",
"format": "int32",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxValueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity."
},
"maxLength": {
"type": "integer",
"format": "int32",
"description": "Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element."
},
"condition": {
"type": "array",
"items": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "A reference to an invariant that may make additional statements about the cardinality or value in the instance."
}
},
"constraint": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementDefinition_Constraint",
"description": "Formal constraints such as co–occurrence and other constraints that can be computationally evaluated within the context of the instance."
}
},
"mustSupport": {
"type": "boolean",
"description": "If true, implementations that produce or consume resources SHALL provide \"support\" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation."
},
"isModifier": {
"type": "boolean",
"description": "If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre–determination has been made that it is not relevant to their particular system."
},
"isModifierReason": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Explains how that element affects the interpretation of the resource or element that contains it."
},
"isSummary": {
"type": "boolean",
"description": "Whether the element should be included if a client requests a search with the parameter _summary=true."
},
"binding": {
"$ref": "#/components/schemas/ElementDefinition_Binding",
"description": "Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri)."
},
"mapping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementDefinition_Mapping",
"description": "Identifies a concept from an external specification that roughly corresponds to this element."
}
}
},
"required": [
"path"
]
}
]
},
"ElementDefinition_Base": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"path": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The Path that identifies the base element – this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element – that is, an element definition on a [StructureDefinition](structuredefinition.html#) without a StructureDefinition.base."
},
"min": {
"type": "integer",
"format": "int32",
"description": "Minimum cardinality of the base element identified by the path."
},
"max": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Maximum cardinality of the base element identified by the path."
}
},
"required": [
"path",
"min",
"max"
]
}
]
},
"ElementDefinition_Binding": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"strength": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Indicates the degree of conformance expectations associated with this binding – that is, the degree to which the provided value set must be adhered to in the instances."
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Describes the intended use of this particular set of codes."
},
"valueSet": {
"type": "string",
"pattern": "\\S*",
"description": "Refers to the value set that identifies the set of codes the binding refers to."
}
},
"required": [
"strength"
]
}
]
},
"ElementDefinition_Constraint": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality."
},
"requirements": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Description of why this constraint is necessary or appropriate."
},
"severity": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies the impact constraint violation has on the conformance of the instance."
},
"human": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Text that can be used to describe the constraint in messages identifying that the constraint has been violated."
},
"expression": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met."
},
"xpath": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "An XPath expression of constraint that can be executed to see if this constraint is met."
},
"source": {
"type": "string",
"pattern": "\\S*",
"description": "A reference to the original source of the constraint, for traceability purposes."
}
},
"required": [
"key",
"severity",
"human"
]
}
]
},
"ElementDefinition_Example": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"label": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Describes the purpose of this example amoung the set of examples."
},
"valueBase64Binary": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueBoolean": {
"type": "boolean",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueCanonical": {
"type": "string",
"pattern": "\\S*",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueDecimal": {
"type": "number",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueId": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueInteger": {
"type": "integer",
"format": "int32",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueMarkdown": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueOid": {
"type": "string",
"pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valuePositiveInt": {
"type": "integer",
"format": "int32",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueUri": {
"type": "string",
"pattern": "\\S*",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueUrl": {
"type": "string",
"pattern": "\\S*",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueUuid": {
"type": "string",
"pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueAddress": {
"$ref": "#/components/schemas/Address",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueAge": {
"$ref": "#/components/schemas/Age",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueAnnotation": {
"$ref": "#/components/schemas/Annotation",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueCoding": {
"$ref": "#/components/schemas/Coding",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueContactPoint": {
"$ref": "#/components/schemas/ContactPoint",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueCount": {
"$ref": "#/components/schemas/Count",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueDistance": {
"$ref": "#/components/schemas/Distance",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueDuration": {
"$ref": "#/components/schemas/Duration",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueHumanName": {
"$ref": "#/components/schemas/HumanName",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueMoney": {
"$ref": "#/components/schemas/Money",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valuePeriod": {
"$ref": "#/components/schemas/Period",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueRange": {
"$ref": "#/components/schemas/Range",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueReference": {
"$ref": "#/components/schemas/Reference",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueSignature": {
"$ref": "#/components/schemas/Signature",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueTiming": {
"$ref": "#/components/schemas/Timing",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueContactDetail": {
"$ref": "#/components/schemas/ContactDetail",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueRelatedArtifact": {
"$ref": "#/components/schemas/RelatedArtifact",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueUsageContext": {
"$ref": "#/components/schemas/UsageContext",
"description": "The actual value for the element, which must be one of the types allowed for this element."
},
"valueMeta": {
"$ref": "#/components/schemas/Meta",
"description": "The actual value for the element, which must be one of the types allowed for this element."
}
},
"required": [
"label"
]
}
]
},
"ElementDefinition_Mapping": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"identity": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "An internal reference to the definition of a mapping."
},
"language": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Identifies the computable language in which mapping.map is expressed."
},
"map": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Expresses what part of the target specification corresponds to this element."
},
"comment": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Comments that provide information about the mapping or its use."
}
},
"required": [
"identity",
"map"
]
}
]
},
"ElementDefinition_Slicing": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"discriminator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementDefinition_Slicing_Discriminator",
"description": "Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A human–readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated."
},
"ordered": {
"type": "boolean",
"description": "If the matching elements have to occur in the same order as defined in the profile."
},
"rules": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end."
}
},
"required": [
"rules"
]
}
]
},
"ElementDefinition_Slicing_Discriminator": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "How the element value is interpreted when discrimination is evaluated."
},
"path": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based."
}
},
"required": [
"type",
"path"
]
}
]
},
"ElementDefinition_Type": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "\\S*",
"description": "URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models."
},
"profile": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference – to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide."
}
},
"targetProfile": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference – to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide."
}
},
"aggregation": {
"type": "array",
"items": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "If the type is a reference to another resource, how the resource is or can be aggregated – is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle."
}
},
"versioning": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Whether this reference needs to be version specific or version independent, or whether either can be used."
}
},
"required": [
"code"
]
}
]
},
"ValueSet": {
"allOf": [
{
"$ref": "#/components/schemas/DomainResource"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers."
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier",
"description": "A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance."
}
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence."
},
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation."
},
"title": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A short, descriptive, user–friendly title for the value set."
},
"status": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The status of this value set. Enables tracking the life–cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state."
},
"experimental": {
"type": "boolean",
"description": "A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage."
},
"date": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition')."
},
"publisher": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the organization or individual that published the value set."
},
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactDetail",
"description": "Contact details to assist a user in finding and communicating with the publisher."
}
},
"description": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set."
},
"useContext": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageContext",
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances."
}
},
"jurisdiction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "A legal or geographic region in which the value set is intended to be used."
}
},
"immutable": {
"type": "boolean",
"description": "If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change."
},
"purpose": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Explanation of why this value set is needed and why it has been designed as it has."
},
"copyright": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set."
},
"compose": {
"$ref": "#/components/schemas/ValueSet_Compose",
"description": "A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD)."
},
"expansion": {
"$ref": "#/components/schemas/ValueSet_Expansion",
"description": "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed."
}
},
"required": [
"status"
]
}
],
"example": {
"resourceType": "ValueSet",
"meta": {
"versionId": "ZJCTZUnazR",
"lastUpdated": "2021-04-12T14:34:37.916-05:00",
"source": "XshRnk8oi2",
"profile": [
"xsHyROVhVq"
],
"security": [
{
"system": "4HDqfiH0ws",
"version": "LEJCxhHdMW",
"code": "vxobRFEjYy",
"display": "P1FkG143Js",
"userSelected": true
}
],
"tag": [
{
"system": "CBEJFYp6XQ",
"version": "IyNJy_9fKp",
"code": "2gyRjs142P",
"display": "2QaJlwkzpd",
"userSelected": true
},
{
"code": "ibm/complete-mock"
}
]
},
"implicitRules": "OTwo_jHd1x",
"language": "en-US",
"text": {
"status": "empty",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"></div>"
},
"url": "MpxkhSQza6",
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "iFTGwZx5Wn",
"version": "NwBFoEiBCn",
"code": "zoWFJd8u7J",
"display": "bEv07acnh8",
"userSelected": true
}
],
"text": "a7HuYZNKQL"
},
"system": "18jE3k89k6",
"value": "jioHjTF6m5",
"period": {
"start": "2021-04-12T14:34:37.914-05:00",
"end": "2021-04-12T14:34:37.914-05:00"
}
}
],
"version": "gaC0lWv6xb",
"name": "98Yfx3nee6",
"title": "j2osMnyJSi",
"status": "draft",
"experimental": true,
"date": "2021-04-12T14:34:37.916-05:00",
"publisher": "yxyiNITLb2",
"contact": [
{
"name": "BhxMTgLpo7",
"telecom": [
{
"system": "other",
"value": "tM1zS1d5vh",
"use": "mobile",
"rank": 253581053,
"period": {
"start": "2021-04-12T14:34:37.915-05:00",
"end": "2021-04-12T14:34:37.915-05:00"
}
}
]
}
],
"description": "dDy2y5UodK",
"useContext": [
{
"code": {
"system": "_IGTNXYx27",
"version": "o5AfPfXlCK",
"code": "WYRUEoDBPb",
"display": "4d9I0VCZpj",
"userSelected": true
},
"valueCodeableConcept": {
"coding": [
{
"system": "wp41c47WBF",
"version": "xj6hagBKY8",
"code": "mVba1G9kCO",
"display": "_kjrS5bczs",
"userSelected": true
}
],
"text": "HRdrzvSGlw"
}
}
],
"jurisdiction": [
{
"coding": [
{
"system": "7she7OAoVE",
"version": "WoZCV26sWy",
"code": "deflcVXa4h",
"display": "zi7GxPWg1w",
"userSelected": true
}
],
"text": "9GmDu23xTn"
}
],
"immutable": true,
"purpose": "iFdw6xMieP",
"copyright": "UvcIrl7QIj",
"compose": {
"lockedDate": "2021-04-12",
"inactive": true,
"include": [
{
"system": "YiMPvK5QvP",
"version": "su1QOVVGhW",
"concept": [
{
"code": "tW1s3_f96D",
"display": "4e1T8538ba",
"designation": [
{
"language": "en-US",
"use": {
"system": "t9ntOk9wWq",
"version": "KV0yDphUBJ",
"code": "WcFbT5k9PF",
"display": "1QwNRCpweH",
"userSelected": true
},
"value": "EJi3qwe_aN"
}
]
}
],
"valueSet": [
"lQG_rTO5M5"
]
}
],
"exclude": [
{
"system": "qwpzFAEPmx",
"version": "GJXrZhn7ce",
"concept": [
{
"code": "BCXGwP_UeZ",
"display": "ZrQToq_yIR",
"designation": [
{
"language": "en-US",
"use": {
"system": "Ou28E0lWdX",
"version": "kINGy39Xtj",
"code": "gy_EsvTMMn",
"display": "Fh7JCf_bfw",
"userSelected": true
},
"value": "HYr8K4337l"
}
]
}
],
"valueSet": [
"7DZaLpiV6a"
]
}
]
},
"expansion": {
"identifier": "FM1Xnn_D47",
"timestamp": "2021-04-12T14:34:37.922-05:00",
"total": 1366127382,
"offset": 1070106423,
"parameter": [
{
"name": "Ez__C6GpAK",
"valueString": "XEelGTAjYm"
}
],
"contains": [
{
"system": "9emJk5p_g9",
"abstract": true,
"inactive": true,
"version": "OFnYXUVMGp",
"code": "GUnx_W150S",
"display": "j0fAo75Z7o",
"designation": [
{
"language": "en-US",
"use": {
"system": "1_CZcGKZwI",
"version": "0qdWrOaAFU",
"code": "_TGhGIeTYH",
"display": "s2gZWD2983",
"userSelected": true
},
"value": "lk2d49pjgQ"
}
]
}
]
}
}
},
"ValueSet_Compose": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"lockedDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version."
},
"inactive": {
"type": "boolean",
"description": "Whether inactive codes – codes that are not approved for current use – are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included)."
},
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Compose_Include",
"description": "Include one or more codes from a code system or other value set(s)."
},
"minItems": 1
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Compose_Include",
"description": "Exclude one or more codes from the value set based on code system filters and/or other value sets."
}
}
},
"required": [
"include"
]
}
]
},
"ValueSet_Compose_Include": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"system": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI which is the code system from which the selected codes come from."
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The version of the code system that the codes are selected from, or the special version '*' for all versions."
},
"concept": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Compose_Include_Concept",
"description": "Specifies a concept to be included or excluded."
}
},
"filter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Compose_Include_Filter",
"description": "Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true."
}
},
"valueSet": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S*",
"description": "Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets."
}
}
}
}
]
},
"ValueSet_Compose_Include_Concept": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "Specifies a code for the concept to be included or excluded."
},
"display": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system."
},
"designation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Compose_Include_Concept_Designation",
"description": "Additional representations for this concept when used in this value set – other languages, aliases, specialized purposes, used for particular purposes, etc."
}
}
},
"required": [
"code"
]
}
]
},
"ValueSet_Compose_Include_Concept_Designation": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"language": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The language this designation is defined for."
},
"use": {
"$ref": "#/components/schemas/Coding",
"description": "A code that represents types of uses of designations."
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The text value for this designation."
}
},
"required": [
"value"
]
}
]
},
"ValueSet_Compose_Include_Filter": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"property": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "A code that identifies a property or a filter defined in the code system."
},
"op": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The kind of operation to perform as a part of the filter criteria."
},
"value": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'."
}
},
"required": [
"property",
"op",
"value"
]
}
]
},
"ValueSet_Expansion": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"pattern": "\\S*",
"description": "An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re–use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier."
},
"timestamp": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The time at which the expansion was produced by the expanding system."
},
"total": {
"type": "integer",
"format": "int32",
"description": "The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present."
},
"parameter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Expansion_Parameter",
"description": "A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion."
}
},
"contains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Expansion_Contains",
"description": "The codes that are contained in the value set expansion."
}
}
},
"required": [
"timestamp"
]
}
]
},
"ValueSet_Expansion_Contains": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"system": {
"type": "string",
"pattern": "\\S*",
"description": "An absolute URI which is the code system in which the code for this item in the expansion is defined."
},
"abstract": {
"type": "boolean",
"description": "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value."
},
"inactive": {
"type": "boolean",
"description": "If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use)."
},
"version": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The version of the code system from this code was taken. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged."
},
"code": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set."
},
"display": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The recommended display for this item in the expansion."
},
"designation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Compose_Include_Concept_Designation",
"description": "Additional representations for this item – other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation."
}
},
"contains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueSet_Expansion_Contains",
"description": "Other codes and entries contained under this entry in the hierarchy."
}
}
}
}
]
},
"ValueSet_Expansion_Parameter": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "Name of the input parameter to the $expand operation; may be a server–assigned name for additional default or other server–supplied parameters used to control the expansion process."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The value of the parameter."
},
"valueBoolean": {
"type": "boolean",
"description": "The value of the parameter."
},
"valueInteger": {
"type": "integer",
"format": "int32",
"description": "The value of the parameter."
},
"valueDecimal": {
"type": "number",
"description": "The value of the parameter."
},
"valueUri": {
"type": "string",
"pattern": "\\S*",
"description": "The value of the parameter."
},
"valueCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "The value of the parameter."
},
"valueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "The value of the parameter."
}
},
"required": [
"name"
]
}
]
},
"Parameters_Parameter": {
"allOf": [
{
"$ref": "#/components/schemas/BackboneElement"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "The name of the parameter (reference to the operation definition)."
},
"valueBase64Binary": {
"type": "string",
"pattern": "(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+",
"description": "If the parameter is a data type."
},
"valueBoolean": {
"type": "boolean",
"description": "If the parameter is a data type."
},
"valueCanonical": {
"type": "string",
"pattern": "\\S*",
"description": "If the parameter is a data type."
},
"valueCode": {
"type": "string",
"pattern": "[^\\s]+(\\s[^\\s]+)*",
"description": "If the parameter is a data type."
},
"valueDate": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?",
"description": "If the parameter is a data type."
},
"valueDateTime": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
"description": "If the parameter is a data type."
},
"valueDecimal": {
"type": "number",
"description": "If the parameter is a data type."
},
"valueId": {
"type": "string",
"pattern": "[A-Za-z0-9\\-\\.]{1,64}",
"description": "If the parameter is a data type."
},
"valueInstant": {
"type": "string",
"pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
"description": "If the parameter is a data type."
},
"valueInteger": {
"type": "integer",
"format": "int32",
"description": "If the parameter is a data type."
},
"valueMarkdown": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "If the parameter is a data type."
},
"valueOid": {
"type": "string",
"pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+",
"description": "If the parameter is a data type."
},
"valuePositiveInt": {
"type": "integer",
"format": "int32",
"description": "If the parameter is a data type."
},
"valueString": {
"type": "string",
"pattern": "[ \\r\\n\\t\\S]+",
"description": "If the parameter is a data type."
},
"valueTime": {
"type": "string",
"pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
"description": "If the parameter is a data type."
},
"valueUnsignedInt": {
"type": "integer",
"format": "int32",
"description": "If the parameter is a data type."
},
"valueUri": {
"type": "string",
"pattern": "\\S*",
"description": "If the parameter is a data type."
},
"valueUrl": {
"type": "string",
"pattern": "\\S*",
"description": "If the parameter is a data type."
},
"valueUuid": {
"type": "string",
"pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
"description": "If the parameter is a data type."
},
"valueAddress": {
"$ref": "#/components/schemas/Address",
"description": "If the parameter is a data type."
},
"valueAge": {
"$ref": "#/components/schemas/Age",
"description": "If the parameter is a data type."
},
"valueAnnotation": {
"$ref": "#/components/schemas/Annotation",
"description": "If the parameter is a data type."
},
"valueAttachment": {
"$ref": "#/components/schemas/Attachment",
"description": "If the parameter is a data type."
},
"valueCodeableConcept": {
"$ref": "#/components/schemas/CodeableConcept",
"description": "If the parameter is a data type."
},
"valueCoding": {
"$ref": "#/components/schemas/Coding",
"description": "If the parameter is a data type."
},
"valueContactPoint": {
"$ref": "#/components/schemas/ContactPoint",
"description": "If the parameter is a data type."
},
"valueCount": {
"$ref": "#/components/schemas/Count",
"description": "If the parameter is a data type."
},
"valueDistance": {
"$ref": "#/components/schemas/Distance",
"description": "If the parameter is a data type."
},
"valueDuration": {
"$ref": "#/components/schemas/Duration",
"description": "If the parameter is a data type."
},
"valueHumanName": {
"$ref": "#/components/schemas/HumanName",
"description": "If the parameter is a data type."
},
"valueIdentifier": {
"$ref": "#/components/schemas/Identifier",
"description": "If the parameter is a data type."
},
"valueMoney": {
"$ref": "#/components/schemas/Money",
"description": "If the parameter is a data type."
},
"valuePeriod": {
"$ref": "#/components/schemas/Period",
"description": "If the parameter is a data type."
},
"valueQuantity": {
"$ref": "#/components/schemas/Quantity",
"description": "If the parameter is a data type."
},
"valueRange": {
"$ref": "#/components/schemas/Range",
"description": "If the parameter is a data type."
},
"valueRatio": {
"$ref": "#/components/schemas/Ratio",
"description": "If the parameter is a data type."
},
"valueReference": {
"$ref": "#/components/schemas/Reference",
"description": "If the parameter is a data type."
},
"valueSampledData": {
"$ref": "#/components/schemas/SampledData",
"description": "If the parameter is a data type."
},
"valueSignature": {
"$ref": "#/components/schemas/Signature",
"description": "If the parameter is a data type."
},
"valueTiming": {
"$ref": "#/components/schemas/Timing",
"description": "If the parameter is a data type."
},
"valueContactDetail": {
"$ref": "#/components/schemas/ContactDetail",
"description": "If the parameter is a data type."
},
"valueRelatedArtifact": {
"$ref": "#/components/schemas/RelatedArtifact",
"description": "If the parameter is a data type."
},
"valueUsageContext": {
"$ref": "#/components/schemas/UsageContext",
"description": "If the parameter is a data type."
},
"valueMeta": {
"$ref": "#/components/schemas/Meta",
"description": "If the parameter is a data type."
},
"resource": {
"$ref": "#/components/schemas/Resource",
"description": "If the parameter is a whole resource."
},
"part": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Parameters_Parameter",
"description": "A named part of a multi–part parameter."
}
}
},
"required": [
"name"
]
}
]
}
}
}
}