{ "openapi": "3.0.3", "info": { "title": "Nextech Partner API (STU3)", "description": "FHIR STU3-based partner API for Nextech Select EHR. Requires Bearer token + nx-practice-id header on all requests. See x-apim-guidance extension for Azure API Management import notes.", "version": "1.0.0", "contact": { "name": "Nextech Developer Support", "url": "http://landing.nextech.com/developers-portal-registration-form" }, "x-apim-guidance": "Import as OpenAPI 3.0.3. Set subscription key header to nx-practice-id. Configure OAuth2 token endpoint: https://login.microsoftonline.com/nextech-api.com/oauth2/token" }, "servers": [ { "url": "https://select.nextech-api.com/api", "description": "Nextech Select Production API" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth2 Bearer token from https://login.microsoftonline.com/nextech-api.com/oauth2/token" }, "practiceId": { "type": "apiKey", "in": "header", "name": "nx-practice-id", "description": "Nextech Practice ID header" } }, "schemas": { "Bundle": { "type": "object", "description": "FHIR Bundle", "properties": { "resourceType": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer" }, "entry": { "type": "array", "items": { "type": "object", "properties": { "fullUrl": { "type": "string" }, "resource": { "type": "object" } } } } } }, "FhirResource": { "type": "object", "description": "Base FHIR resource", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } } } }, "ErrorResponse": { "type": "object", "description": "FHIR OperationOutcome", "properties": { "resourceType": { "type": "string" }, "issue": { "type": "array", "items": { "type": "object", "properties": { "severity": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "object", "properties": { "text": { "type": "string" } } } } } } } }, "Appointment": { "type": "object", "description": "FHIR STU3 Appointment", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "status": { "type": "string" }, "serviceType": { "type": "array", "items": { "type": "object" } }, "appointmentType": { "type": "object" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "minutesDuration": { "type": "integer" }, "created": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "participant": { "type": "array", "items": { "type": "object", "properties": { "actor": { "type": "object", "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } }, "status": { "type": "string" } } } } } }, "AppointmentCreate": { "type": "object", "description": "Book appointment request", "required": [ "status", "start", "end" ], "properties": { "resourceType": { "type": "string" }, "status": { "type": "string" }, "appointmentType": { "type": "object" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "participant": { "type": "array", "items": { "type": "object", "properties": { "actor": { "type": "object", "properties": { "reference": { "type": "string" } } }, "status": { "type": "string" } } } } } }, "AppointmentUpdate": { "type": "object", "description": "Update appointment request", "properties": { "resourceType": { "type": "string" }, "status": { "type": "string" }, "comment": { "type": "string" } } }, "AppointmentPurpose": { "type": "object", "description": "Appointment purpose", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "name": { "type": "string" }, "status": { "type": "string" } } }, "AppointmentStatus": { "type": "object", "description": "Appointment status", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "name": { "type": "string" }, "status": { "type": "string" } } }, "AppointmentType": { "type": "object", "description": "Appointment type", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "name": { "type": "string" }, "status": { "type": "string" } } }, "Account": { "type": "object", "description": "FHIR STU3 Account", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "status": { "type": "string" }, "name": { "type": "string" }, "balance": { "type": "object", "properties": { "value": { "type": "number" }, "currency": { "type": "string" } } }, "subject": { "type": "object", "properties": { "reference": { "type": "string" } } } } }, "Claim": { "type": "object", "description": "FHIR STU3 Claim", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "status": { "type": "string" }, "use": { "type": "string" }, "patient": { "type": "object", "properties": { "reference": { "type": "string" } } }, "created": { "type": "string", "format": "date-time" }, "facility": { "type": "object", "properties": { "reference": { "type": "string" } } }, "careTeam": { "type": "array", "items": { "type": "object", "properties": { "sequence": { "type": "integer" }, "provider": { "type": "object", "properties": { "reference": { "type": "string" } } } } } }, "diagnosis": { "type": "array", "items": { "type": "object" } }, "item": { "type": "array", "items": { "type": "object" } } } }, "Coverage": { "type": "object", "description": "FHIR STU3 Coverage", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "beneficiary": { "type": "object", "properties": { "reference": { "type": "string" } } }, "payor": { "type": "array", "items": { "type": "object", "properties": { "reference": { "type": "string" }, "display": { "type": "string" } } } }, "grouping": { "type": "object", "properties": { "plan": { "type": "string" }, "planDisplay": { "type": "string" } } } } }, "Location": { "type": "object", "description": "FHIR STU3 Location", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "status": { "type": "string" }, "name": { "type": "string" }, "telecom": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" }, "use": { "type": "string" } } } }, "address": { "type": "object", "properties": { "line": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } } } } }, "Patient": { "type": "object", "description": "FHIR STU3 Patient", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "active": { "type": "boolean" }, "name": { "type": "array", "items": { "type": "object", "properties": { "use": { "type": "string" }, "family": { "type": "string" }, "given": { "type": "array", "items": { "type": "string" } } } } }, "telecom": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" }, "use": { "type": "string" } } } }, "gender": { "type": "string" }, "birthDate": { "type": "string", "format": "date" }, "address": { "type": "array", "items": { "type": "object", "properties": { "line": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } } } } } }, "PatientCreate": { "type": "object", "description": "Create patient request", "required": [ "resourceType", "name", "birthDate" ], "properties": { "resourceType": { "type": "string" }, "name": { "type": "array", "items": { "type": "object", "properties": { "use": { "type": "string" }, "family": { "type": "string" }, "given": { "type": "array", "items": { "type": "string" } } } } }, "telecom": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" }, "use": { "type": "string" } } } }, "gender": { "type": "string" }, "birthDate": { "type": "string", "format": "date" }, "address": { "type": "array", "items": { "type": "object", "properties": { "line": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } } } } } }, "PatientUpdate": { "type": "object", "description": "Update patient request", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "array", "items": { "type": "object", "properties": { "use": { "type": "string" }, "family": { "type": "string" }, "given": { "type": "array", "items": { "type": "string" } } } } }, "telecom": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" }, "use": { "type": "string" } } } }, "gender": { "type": "string" }, "birthDate": { "type": "string", "format": "date" }, "address": { "type": "array", "items": { "type": "object", "properties": { "line": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } } } } } }, "AllergyIntolerance": { "type": "object", "description": "FHIR STU3 AllergyIntolerance", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "clinicalStatus": { "type": "string" }, "verificationStatus": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "array", "items": { "type": "string" } }, "criticality": { "type": "string" }, "code": { "type": "object" }, "patient": { "type": "object" }, "onsetDateTime": { "type": "string" }, "assertedDate": { "type": "string" }, "reaction": { "type": "array", "items": { "type": "object", "properties": { "manifestation": { "type": "array", "items": { "type": "object" } }, "severity": { "type": "string" } } } } } }, "Binary": { "type": "object", "description": "FHIR STU3 Binary (CCD)", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "contentType": { "type": "string" }, "content": { "type": "string", "description": "Base64-encoded binary content" } } }, "CarePlan": { "type": "object", "description": "FHIR STU3 CarePlan", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "intent": { "type": "string" }, "subject": { "type": "object" }, "period": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } } }, "activity": { "type": "array", "items": { "type": "object" } }, "goal": { "type": "array", "items": { "type": "object" } } } }, "ClinicalImpression": { "type": "object", "description": "FHIR STU3 ClinicalImpression", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "subject": { "type": "object" }, "date": { "type": "string", "format": "date-time" }, "assessor": { "type": "object" }, "summary": { "type": "string" }, "finding": { "type": "array", "items": { "type": "object" } } } }, "Composition": { "type": "object", "description": "FHIR STU3 Composition", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "type": { "type": "object" }, "subject": { "type": "object" }, "date": { "type": "string", "format": "date-time" }, "author": { "type": "array", "items": { "type": "object" } }, "title": { "type": "string" }, "section": { "type": "array", "items": { "type": "object" } } } }, "CompositionCreate": { "type": "object", "description": "Create composition request", "required": [ "resourceType", "status", "type", "subject", "date", "author", "title" ], "properties": { "resourceType": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "object" }, "subject": { "type": "object" }, "date": { "type": "string", "format": "date-time" }, "author": { "type": "array", "items": { "type": "object" } }, "title": { "type": "string" }, "section": { "type": "array", "items": { "type": "object" } } } }, "Condition": { "type": "object", "description": "FHIR STU3 Condition", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "clinicalStatus": { "type": "string" }, "verificationStatus": { "type": "string" }, "category": { "type": "array", "items": { "type": "object" } }, "code": { "type": "object" }, "subject": { "type": "object" }, "onsetDateTime": { "type": "string" }, "abatementDateTime": { "type": "string" }, "assertedDate": { "type": "string" } } }, "Device": { "type": "object", "description": "FHIR STU3 Device", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "status": { "type": "string" }, "type": { "type": "object" }, "patient": { "type": "object" }, "owner": { "type": "object" }, "note": { "type": "array", "items": { "type": "object" } } } }, "DocumentReference": { "type": "object", "description": "FHIR STU3 DocumentReference", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "type": { "type": "object" }, "subject": { "type": "object" }, "created": { "type": "string", "format": "date-time" }, "indexed": { "type": "string", "format": "date-time" }, "author": { "type": "array", "items": { "type": "object" } }, "content": { "type": "array", "items": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "contentType": { "type": "string" }, "data": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" } } } } } }, "context": { "type": "object" } } }, "DocumentReferenceCreate": { "type": "object", "description": "Create DocumentReference request (max 10MB)", "required": [ "resourceType", "status", "type", "subject", "indexed", "author", "content" ], "properties": { "resourceType": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "object" }, "subject": { "type": "object" }, "created": { "type": "string", "format": "date-time" }, "indexed": { "type": "string", "format": "date-time" }, "author": { "type": "array", "items": { "type": "object" } }, "content": { "type": "array", "items": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "contentType": { "type": "string" }, "data": { "type": "string" }, "title": { "type": "string" } } } } } } } }, "Encounter": { "type": "object", "description": "FHIR STU3 Encounter", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "status": { "type": "string" }, "class": { "type": "object" }, "type": { "type": "array", "items": { "type": "object" } }, "subject": { "type": "object" }, "period": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } } }, "participant": { "type": "array", "items": { "type": "object" } }, "location": { "type": "array", "items": { "type": "object" } } } }, "Goal": { "type": "object", "description": "FHIR STU3 Goal", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "description": { "type": "object" }, "subject": { "type": "object" }, "startDate": { "type": "string", "format": "date" }, "target": { "type": "object" }, "note": { "type": "array", "items": { "type": "object" } } } }, "Immunization": { "type": "object", "description": "FHIR STU3 Immunization", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "notGiven": { "type": "boolean" }, "vaccineCode": { "type": "object" }, "patient": { "type": "object" }, "date": { "type": "string", "format": "date-time" }, "primarySource": { "type": "boolean" }, "lotNumber": { "type": "string" }, "site": { "type": "object" }, "route": { "type": "object" }, "doseQuantity": { "type": "object" } } }, "MedicationDispense": { "type": "object", "description": "FHIR STU3 MedicationDispense", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "medicationCodeableConcept": { "type": "object" }, "subject": { "type": "object" }, "whenPrepared": { "type": "string", "format": "date-time" }, "whenHandedOver": { "type": "string", "format": "date-time" }, "quantity": { "type": "object" }, "daysSupply": { "type": "object" }, "dosageInstruction": { "type": "array", "items": { "type": "object" } } } }, "MedicationStatement": { "type": "object", "description": "FHIR STU3 MedicationStatement", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "medicationCodeableConcept": { "type": "object" }, "subject": { "type": "object" }, "effectiveDateTime": { "type": "string" }, "effectivePeriod": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } } }, "taken": { "type": "string" }, "dosage": { "type": "array", "items": { "type": "object" } } } }, "Observation": { "type": "object", "description": "FHIR STU3 Observation", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "category": { "type": "array", "items": { "type": "object" } }, "code": { "type": "object" }, "subject": { "type": "object" }, "effectiveDateTime": { "type": "string" }, "issued": { "type": "string" }, "valueQuantity": { "type": "object" }, "valueString": { "type": "string" }, "valueCodeableConcept": { "type": "object" }, "interpretation": { "type": "object" }, "component": { "type": "array", "items": { "type": "object" } } } }, "PatientPaymentCreate": { "type": "object", "description": "Create patient payment request", "required": [ "resourceType", "status", "paymentDate", "paymentAmount" ], "properties": { "resourceType": { "type": "string" }, "status": { "type": "string" }, "paymentDate": { "type": "string", "format": "date" }, "paymentAmount": { "type": "object", "properties": { "value": { "type": "number" }, "currency": { "type": "string" } } }, "paymentIdentifier": { "type": "object" }, "detail": { "type": "array", "items": { "type": "object" } }, "requestProvider": { "type": "object" }, "requestOrganization": { "type": "object" } } }, "Procedure": { "type": "object", "description": "FHIR STU3 Procedure", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "status": { "type": "string" }, "code": { "type": "object" }, "subject": { "type": "object" }, "performedDateTime": { "type": "string" }, "performedPeriod": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } } }, "performer": { "type": "array", "items": { "type": "object" } }, "bodySite": { "type": "array", "items": { "type": "object" } }, "outcome": { "type": "object" }, "note": { "type": "array", "items": { "type": "object" } } } }, "PatientRecall": { "type": "object", "description": "Patient recall resource", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "subject": { "type": "object" }, "created": { "type": "string", "format": "date-time" }, "location": { "type": "object" }, "practitioner": { "type": "object" }, "recallStatusName": { "type": "string" }, "recallDate": { "type": "string", "format": "date" }, "deleted": { "type": "boolean" }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "PatientType": { "type": "object", "description": "Patient type resource", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "name": { "type": "string" }, "status": { "type": "string" } } }, "PaymentReconciliation": { "type": "object", "description": "FHIR STU3 PaymentReconciliation", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "paymentDate": { "type": "string", "format": "date" }, "paymentAmount": { "type": "object", "properties": { "value": { "type": "number" }, "currency": { "type": "string" } } }, "requestProvider": { "type": "object" }, "detail": { "type": "array", "items": { "type": "object" } } } }, "Practitioner": { "type": "object", "description": "FHIR STU3 Practitioner", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "identifier": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" } } } }, "active": { "type": "boolean" }, "name": { "type": "array", "items": { "type": "object", "properties": { "use": { "type": "string" }, "family": { "type": "string" }, "given": { "type": "array", "items": { "type": "string" } } } } }, "telecom": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string" }, "value": { "type": "string" }, "use": { "type": "string" } } } }, "address": { "type": "array", "items": { "type": "object", "properties": { "line": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } } } }, "qualification": { "type": "array", "items": { "type": "object" } } } }, "Slot": { "type": "object", "description": "FHIR STU3 Slot", "properties": { "resourceType": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "properties": { "versionId": { "type": "string" }, "lastUpdated": { "type": "string" } } }, "schedule": { "type": "object" }, "status": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "serviceType": { "type": "array", "items": { "type": "object" } }, "appointmentType": { "type": "object" }, "comment": { "type": "string" } } } } }, "paths": { "/Appointment": { "get": { "summary": "Search Appointments", "operationId": "searchAppointments", "tags": [ "Appointment" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "_lastUpdated", "in": "query", "required": false, "description": "Last updated date filter", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": false, "description": "Appointment identifier", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "required": false, "description": "Patient reference", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Appointment date", "schema": { "type": "string" } }, { "name": "location.id", "in": "query", "required": false, "description": "Location ID", "schema": { "type": "string" } }, { "name": "location.name", "in": "query", "required": false, "description": "Location name", "schema": { "type": "string" } }, { "name": "practitioner.id", "in": "query", "required": false, "description": "Practitioner ID", "schema": { "type": "string" } }, { "name": "practitioner.name", "in": "query", "required": false, "description": "Practitioner name", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Appointment status", "schema": { "type": "string" } }, { "name": "created", "in": "query", "required": false, "description": "Created date", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "summary": "Book an Appointment", "operationId": "createAppointment", "tags": [ "Appointment" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreate" } } } }, "responses": { "201": { "description": "Resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Appointment/{identifier}": { "get": { "summary": "Get Appointment by ID", "operationId": "getAppointmentById", "tags": [ "Appointment" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Appointment identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointment" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "summary": "Update Appointment", "operationId": "updateAppointment", "tags": [ "Appointment" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Appointment identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentUpdate" } } } }, "responses": { "200": { "description": "Resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Appointment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/appointment-purpose": { "get": { "summary": "Search Appointment Purposes", "operationId": "searchAppointmentPurpose", "tags": [ "Appointment-Purpose" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Purpose identifier", "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "description": "Purpose name", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/appointment-purpose/{identifier}": { "get": { "summary": "Get Appointment Purpose by ID", "operationId": "getAppointmentPurposeById", "tags": [ "Appointment-Purpose" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Appointment purpose identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentPurpose" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/appointment-status": { "get": { "summary": "Search Appointment Statuses", "operationId": "searchAppointmentStatus", "tags": [ "Appointment-Status" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Status identifier", "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "description": "Status name", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/appointment-status/{identifier}": { "get": { "summary": "Get Appointment Status by ID", "operationId": "getAppointmentStatusById", "tags": [ "Appointment-Status" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Appointment status identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentStatus" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/appointment-type": { "get": { "summary": "Search Appointment Types", "operationId": "searchAppointmentType", "tags": [ "Appointment-Type" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Type identifier", "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "description": "Type name", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/appointment-type/{identifier}": { "get": { "summary": "Get Appointment Type by ID", "operationId": "getAppointmentTypeById", "tags": [ "Appointment-Type" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Appointment type identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentType" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Account": { "get": { "summary": "Search Accounts", "operationId": "searchAccount", "tags": [ "Account" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Account identifier", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Account status", "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "description": "Account name", "schema": { "type": "string" } }, { "name": "balance", "in": "query", "required": false, "description": "Balance filter", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "required": false, "description": "Patient reference", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Account/{identifier}": { "get": { "summary": "Get Account by ID", "operationId": "getAccountById", "tags": [ "Account" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Account identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Claim": { "get": { "summary": "Search Claims", "operationId": "searchClaim", "tags": [ "Claim" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "_lastUpdated", "in": "query", "required": false, "description": "Last updated filter", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": false, "description": "Claim identifier", "schema": { "type": "string" } }, { "name": "use", "in": "query", "required": false, "description": "Claim use", "schema": { "type": "string" } }, { "name": "facility", "in": "query", "required": false, "description": "Facility reference", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "required": false, "description": "Patient reference", "schema": { "type": "string" } }, { "name": "created", "in": "query", "required": false, "description": "Created date", "schema": { "type": "string" } }, { "name": "care-team", "in": "query", "required": false, "description": "Care team reference", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Claim/{identifier}": { "get": { "summary": "Get Claim by ID", "operationId": "getClaimById", "tags": [ "Claim" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Claim identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Claim" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Coverage": { "get": { "summary": "Search Coverage", "operationId": "searchCoverage", "tags": [ "Coverage" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patient", "in": "query", "required": false, "description": "Patient reference", "schema": { "type": "string" } }, { "name": "beneficiary", "in": "query", "required": false, "description": "Beneficiary reference", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Location": { "get": { "summary": "Search Locations", "operationId": "searchLocation", "tags": [ "Location" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Location identifier", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Location status", "schema": { "type": "string" } }, { "name": "includeAll", "in": "query", "required": false, "description": "Include inactive locations", "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "required": false, "description": "Location name", "schema": { "type": "string" } }, { "name": "address", "in": "query", "required": false, "description": "Address string", "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "required": false, "description": "City", "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "required": false, "description": "State", "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "required": false, "description": "Postal code", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "required": false, "description": "Phone number", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Location/{identifier}": { "get": { "summary": "Get Location by ID", "operationId": "getLocationById", "tags": [ "Location" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Location identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/ID": { "get": { "summary": "Lookup Patient Unique Identifier", "operationId": "lookupPatientIdentifier", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "family", "in": "query", "required": true, "description": "Patient family name", "schema": { "type": "string" } }, { "name": "given", "in": "query", "required": true, "description": "Patient given name", "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "required": true, "description": "Patient birth date (YYYY-MM-DD)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Patient" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient": { "get": { "summary": "Search Patients", "operationId": "searchPatient", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "_lastUpdated", "in": "query", "required": false, "description": "Last updated filter", "schema": { "type": "string" } }, { "name": "family", "in": "query", "required": false, "description": "Family name", "schema": { "type": "string" } }, { "name": "given", "in": "query", "required": false, "description": "Given name", "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "required": false, "description": "Birth date", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "required": false, "description": "Phone number", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "Email address", "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "required": false, "description": "City", "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "required": false, "description": "State", "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "required": false, "description": "Postal code", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": false, "description": "Patient identifier", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "summary": "Create Patient", "operationId": "createPatient", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientCreate" } } } }, "responses": { "201": { "description": "Resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Patient" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{id}": { "get": { "summary": "Get Patient by ID", "operationId": "getPatientById", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Patient ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Patient" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "summary": "Update Patient", "operationId": "updatePatient", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Patient ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientUpdate" } } } }, "responses": { "200": { "description": "Resource updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Patient" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/AllergyIntolerance": { "get": { "summary": "Get Patient AllergyIntolerance", "operationId": "getPatientAllergyIntolerance", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Binary/$autogen-ccd-if": { "get": { "summary": "Get Patient auto-generated CCD Binary", "operationId": "getPatientBinaryCcd", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": false, "description": "Period start date", "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "description": "Period end date", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/CarePlan": { "get": { "summary": "Get Patient CarePlan", "operationId": "getPatientCarePlan", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/ClinicalImpression": { "get": { "summary": "Get Patient ClinicalImpression", "operationId": "getPatientClinicalImpression", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Composition": { "post": { "summary": "Create Patient Composition", "operationId": "createPatientComposition", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompositionCreate" } } } }, "responses": { "201": { "description": "Resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Composition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Condition": { "get": { "summary": "Get Patient Conditions", "operationId": "getPatientCondition", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "onset-date", "in": "query", "required": false, "description": "Onset date filter", "schema": { "type": "string" } }, { "name": "abatement-date", "in": "query", "required": false, "description": "Abatement date filter", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "required": false, "description": "Last updated filter", "schema": { "type": "string" } }, { "name": "_revinclude", "in": "query", "required": false, "description": "Reverse include directive", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Device": { "get": { "summary": "Get Patient Devices", "operationId": "getPatientDevice", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/DocumentReference": { "post": { "summary": "Create Patient DocumentReference (max 10MB)", "operationId": "createPatientDocumentReference", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentReferenceCreate" } } } }, "responses": { "201": { "description": "Resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Encounter": { "get": { "summary": "Get Patient Encounters", "operationId": "getPatientEncounter", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Goal": { "get": { "summary": "Get Patient Goals", "operationId": "getPatientGoal", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Immunization": { "get": { "summary": "Get Patient Immunizations", "operationId": "getPatientImmunization", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/MedicationDispense": { "get": { "summary": "Get Patient MedicationDispense", "operationId": "getPatientMedicationDispense", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "whenPrepared", "in": "query", "required": false, "description": "Preparation date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/MedicationStatement": { "get": { "summary": "Get Patient MedicationStatements", "operationId": "getPatientMedicationStatement", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "effective", "in": "query", "required": false, "description": "Effective date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Observation": { "get": { "summary": "Get Patient Observations", "operationId": "getPatientObservation", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": true, "description": "Observation category (required)", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/PaymentReconciliation": { "post": { "summary": "Create Patient Payment (PaymentReconciliation)", "operationId": "createPatientPayment", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientPaymentCreate" } } } }, "responses": { "201": { "description": "Resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentReconciliation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Patient/{patientUid}/Procedure": { "get": { "summary": "Get Patient Procedures", "operationId": "getPatientProcedure", "tags": [ "Patient" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "patientUid", "in": "path", "required": true, "description": "Patient unique identifier", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Date filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/patient-recall": { "get": { "summary": "Search Patient Recalls", "operationId": "searchPatientRecall", "tags": [ "Patient-Recall" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Recall identifier", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "required": false, "description": "Patient reference", "schema": { "type": "string" } }, { "name": "created", "in": "query", "required": false, "description": "Created date", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "description": "Location reference", "schema": { "type": "string" } }, { "name": "practitioner", "in": "query", "required": false, "description": "Practitioner reference", "schema": { "type": "string" } }, { "name": "recall-status-name", "in": "query", "required": false, "description": "Recall status name", "schema": { "type": "string" } }, { "name": "recall-date", "in": "query", "required": false, "description": "Recall date", "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "required": false, "description": "Include deleted", "schema": { "type": "string" } }, { "name": "last-updated", "in": "query", "required": false, "description": "Last updated date", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/patient-recall/{identifier}": { "get": { "summary": "Get Patient Recall by ID", "operationId": "getPatientRecallById", "tags": [ "Patient-Recall" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Patient recall identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientRecall" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/patient-type": { "get": { "summary": "Search Patient Types", "operationId": "searchPatientType", "tags": [ "Patient-Type" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Patient type identifier", "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "description": "Patient type name", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/patient-type/{identifier}": { "get": { "summary": "Get Patient Type by ID", "operationId": "getPatientTypeById", "tags": [ "Patient-Type" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Patient type identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientType" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/PaymentReconciliation": { "get": { "summary": "Search PaymentReconciliation", "operationId": "searchPaymentReconciliation", "tags": [ "PaymentReconciliation" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "_lastUpdated", "in": "query", "required": false, "description": "Last updated filter", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": false, "description": "Payment reconciliation identifier", "schema": { "type": "string" } }, { "name": "location.id", "in": "query", "required": false, "description": "Location ID", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "required": false, "description": "Patient reference", "schema": { "type": "string" } }, { "name": "created", "in": "query", "required": false, "description": "Created date", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Payment status", "schema": { "type": "string" } }, { "name": "payment-date", "in": "query", "required": false, "description": "Payment date", "schema": { "type": "string" } }, { "name": "request-provider", "in": "query", "required": false, "description": "Requesting provider reference", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/PaymentReconciliation/{identifier}": { "get": { "summary": "Get PaymentReconciliation by ID", "operationId": "getPaymentReconciliationById", "tags": [ "PaymentReconciliation" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Payment reconciliation identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentReconciliation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Practitioner": { "get": { "summary": "Search Practitioners", "operationId": "searchPractitioner", "tags": [ "Practitioner" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "query", "required": false, "description": "Practitioner identifier", "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "description": "Active status filter", "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "required": false, "description": "Full name", "schema": { "type": "string" } }, { "name": "family", "in": "query", "required": false, "description": "Family name", "schema": { "type": "string" } }, { "name": "given", "in": "query", "required": false, "description": "Given name", "schema": { "type": "string" } }, { "name": "address", "in": "query", "required": false, "description": "Address string", "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "required": false, "description": "City", "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "required": false, "description": "State", "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "required": false, "description": "Postal code", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "required": false, "description": "Phone number", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "Email address", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Practitioner/{identifier}": { "get": { "summary": "Get Practitioner by ID", "operationId": "getPractitionerById", "tags": [ "Practitioner" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "description": "Practitioner identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resource found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Slot": { "get": { "summary": "Search available Slots", "operationId": "searchSlot", "tags": [ "Slot" ], "security": [ { "bearerAuth": [], "practiceId": [] } ], "parameters": [ { "name": "start", "in": "query", "required": true, "description": "Slot start date/time (required)", "schema": { "type": "string" } }, { "name": "schedule.actor", "in": "query", "required": true, "description": "Schedule actor reference (required)", "schema": { "type": "string" } }, { "name": "appointment-type", "in": "query", "required": false, "description": "Appointment type filter", "schema": { "type": "string" } }, { "name": "appointment-purpose", "in": "query", "required": false, "description": "Appointment purpose filter", "schema": { "type": "string" } }, { "name": "slot-length", "in": "query", "required": false, "description": "Slot length in minutes", "schema": { "type": "integer" } }, { "name": "_count", "in": "query", "required": false, "description": "Number of results per page (default 10, max 50)", "schema": { "type": "integer", "maximum": 50, "default": 10 } } ], "responses": { "200": { "description": "Successful search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } } }