{ "openapi": "3.1.1", "info": { "title": "Provider Directory API", "description": "The Provider Directory API enables public access to provider directory information, including health insurer's insurance plans, their associated networks, and the organizations and providers that participate in these networks. All resources are based on the resource profiles from the [Da Vinci Payer Data Exchange Plan Net Implementation Guide v1.2.0](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/). This API is publicly accessible and requires no authentication.", "contact": { "name": "St. Luke's Health Plan - API Owner", "email": "developersupport@stlukeshealthplan.org" }, "version": "v1" }, "servers": [ { "url": "https://developer.stlukeshealthplan.org/" } ], "paths": { "/api/FHIR/HealthcareService": { "get": { "tags": [ "HealthcareService" ], "summary": "Search all resources of type HealthcareService based on a set of criteria.", "description": "Resources conform to the\n[Plan-Net HealthcareService](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-HealthcareService.html)\nprofile.", "parameters": [ { "name": "_id", "in": "query", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "name:contains", "in": "query", "schema": { "type": "string" } }, { "name": "name:exact", "in": "query", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "_page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "A searchset Bundle of HealthcareService resources.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PlanNetBundle" } } } }, "400": { "description": "A search parameter is invalid.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/HealthcareService/{id}": { "get": { "tags": [ "HealthcareService" ], "summary": "Read the current state of a HealthcareService resource.", "parameters": [ { "name": "id", "in": "path", "description": "The FHIR ID of the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested HealthcareService resource.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/HealthcareService" } } } }, "400": { "description": "The ID is invalid or badly formed.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "404": { "description": "No HealthcareService was found with the provided ID.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/InsurancePlan": { "get": { "tags": [ "InsurancePlan" ], "summary": "Search all resources of type InsurancePlan based on a set of criteria.", "description": "Resources conform to the\n[Plan-Net InsurancePlan](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-InsurancePlan.html)\nprofile.", "parameters": [ { "name": "_id", "in": "query", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "name:contains", "in": "query", "schema": { "type": "string" } }, { "name": "name:exact", "in": "query", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "_page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "A searchset Bundle of InsurancePlan resources.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PlanNetBundle" } } } }, "400": { "description": "A search parameter is invalid.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/InsurancePlan/{id}": { "get": { "tags": [ "InsurancePlan" ], "summary": "Read the current state of an InsurancePlan resource.", "parameters": [ { "name": "id", "in": "path", "description": "The FHIR ID of the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested InsurancePlan resource.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/InsurancePlan" } } } }, "400": { "description": "The ID is invalid or badly formed.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "404": { "description": "No InsurancePlan was found with the provided ID.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/Location": { "get": { "tags": [ "Location" ], "summary": "Search all resources of type Location based on a set of criteria.", "description": "Resources conform to the\n[Plan-Net Location](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-Location.html)\nprofile.", "parameters": [ { "name": "_id", "in": "query", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "name:contains", "in": "query", "schema": { "type": "string" } }, { "name": "name:exact", "in": "query", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "_page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "A searchset Bundle of Location resources.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PlanNetBundle" } } } }, "400": { "description": "A search parameter is invalid.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/Location/{id}": { "get": { "tags": [ "Location" ], "summary": "Read the current state of a Location resource.", "parameters": [ { "name": "id", "in": "path", "description": "The FHIR ID of the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested Location resource.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "400": { "description": "The ID is invalid or badly formed.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "404": { "description": "No Location was found with the provided ID.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/Organization": { "get": { "tags": [ "Organization" ], "summary": "Search all resources of type Organization based on a set of criteria.", "description": "Includes Plan-Net Network organizations (insurance provider networks), whose\n`type` coding is \"ntwk\". Resources conform to the\n[Plan-Net Organization](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-Organization.html)\nand [Plan-Net Network](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-Network.html)\nprofiles.", "parameters": [ { "name": "_id", "in": "query", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "name:contains", "in": "query", "schema": { "type": "string" } }, { "name": "name:exact", "in": "query", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "_page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "A searchset Bundle of Organization resources.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PlanNetBundle" } } } }, "400": { "description": "A search parameter is invalid.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/Organization/{id}": { "get": { "tags": [ "Organization" ], "summary": "Read the current state of an Organization resource.", "parameters": [ { "name": "id", "in": "path", "description": "The FHIR ID of the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested Organization resource.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "The ID is invalid or badly formed.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "404": { "description": "No Organization was found with the provided ID.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/OrganizationAffiliation": { "get": { "tags": [ "OrganizationAffiliation" ], "summary": "Search all resources of type OrganizationAffiliation based on a set of criteria.", "description": "Resources conform to the\n[Plan-Net OrganizationAffiliation](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-OrganizationAffiliation.html)\nprofile.", "parameters": [ { "name": "_id", "in": "query", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "name:contains", "in": "query", "schema": { "type": "string" } }, { "name": "name:exact", "in": "query", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "_page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "A searchset Bundle of OrganizationAffiliation resources.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PlanNetBundle" } } } }, "400": { "description": "A search parameter is invalid.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/OrganizationAffiliation/{id}": { "get": { "tags": [ "OrganizationAffiliation" ], "summary": "Read the current state of an OrganizationAffiliation resource.", "parameters": [ { "name": "id", "in": "path", "description": "The FHIR ID of the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested OrganizationAffiliation resource.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OrganizationAffiliation" } } } }, "400": { "description": "The ID is invalid or badly formed.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "404": { "description": "No OrganizationAffiliation was found with the provided ID.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/Practitioner": { "get": { "tags": [ "Practitioner" ], "summary": "Search all resources of type Practitioner based on a set of criteria.", "description": "Resources conform to the\n[Plan-Net Practitioner](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-Practitioner.html)\nprofile.", "parameters": [ { "name": "_id", "in": "query", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "name:contains", "in": "query", "schema": { "type": "string" } }, { "name": "name:exact", "in": "query", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "_page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "A searchset Bundle of Practitioner resources.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PlanNetBundle" } } } }, "400": { "description": "A search parameter is invalid.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/Practitioner/{id}": { "get": { "tags": [ "Practitioner" ], "summary": "Read the current state of a Practitioner resource.", "parameters": [ { "name": "id", "in": "path", "description": "The FHIR ID of the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested Practitioner resource.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } }, "400": { "description": "The ID is invalid or badly formed.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "404": { "description": "No Practitioner was found with the provided ID.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/PractitionerRole": { "get": { "tags": [ "PractitionerRole" ], "summary": "Search all resources of type PractitionerRole based on a set of criteria.", "description": "Resources conform to the\n[Plan-Net PractitionerRole](https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1.2/StructureDefinition-plannet-PractitionerRole.html)\nprofile.", "parameters": [ { "name": "_id", "in": "query", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "name:contains", "in": "query", "schema": { "type": "string" } }, { "name": "name:exact", "in": "query", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "_page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "A searchset Bundle of PractitionerRole resources.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PlanNetBundle" } } } }, "400": { "description": "A search parameter is invalid.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/PractitionerRole/{id}": { "get": { "tags": [ "PractitionerRole" ], "summary": "Read the current state of a PractitionerRole resource.", "parameters": [ { "name": "id", "in": "path", "description": "The FHIR ID of the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested PractitionerRole resource.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } }, "400": { "description": "The ID is invalid or badly formed.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "404": { "description": "No PractitionerRole was found with the provided ID.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } } } } } } }, "/api/FHIR/metadata": { "get": { "tags": [ "metadata" ], "summary": "Capability Statement - describes the resource types published by this server, the\ninteractions each supports (read and search) and the available search parameters.", "responses": { "200": { "description": "The server capability statement.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CapabilityStatement" } } } } } } }, "/api/FHIR/BulkPublish/Public/PlanNet": { "get": { "tags": [ "Bulk Publish" ], "summary": "File Manifest - lists the most-recently generated batch of files containing\nprovider directory information.", "description": "Each generated file contains up to 2000 FHIR resources. If more than 2000 FHIR\nresources were generated for a given resource type, multiple files will be\ngenerated for that resource type. Each file referenced by `output.url` can be\ndownloaded via the Fetch File endpoint.", "parameters": [ { "name": "bulkRequestId", "in": "query", "description": "Optional. The upstream bulk publish request ID (e.g. \"PlanNet\"). When omitted, the server's configured default is used.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The current file manifest.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileManifest" } } } }, "400": { "description": "No bulkRequestId was supplied and no default is configured, or it contains invalid characters.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } }, "application/json": { } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } }, "application/json": { } } } } } }, "/api/FHIR/BulkPublish/Public/{bulkPublishId}/{fileId}": { "get": { "tags": [ "Bulk Publish" ], "summary": "Fetch File - downloads a file listed by the file manifest. Each file contains\nresources of a given type in newline delimited JSON (ndjson) format; Bundle-style\npublishes return a FHIR Bundle of provider directory resources instead.", "description": "Call the File Manifest endpoint first: each `output.url` entry ends with\n`.../{bulkPublishId}/{fileId}`, which are the two values this endpoint needs.", "parameters": [ { "name": "bulkPublishId", "in": "path", "description": "The provider directory API published bulk file ID (\"PlanNet-A\" or \"PlanNet-B\"), taken from a manifest `output.url`.", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "The ID associated with the generated file - the last segment of a manifest `output.url`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested file containing FHIR provider directory resources.", "content": { "application/json": { }, "application/fhir+json": { } } }, "400": { "description": "A route value contains invalid characters.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } }, "application/json": { } } }, "404": { "description": "The requested file was not found.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } }, "application/json": { } } }, "502": { "description": "The upstream provider directory service could not be reached.", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/OperationOutcome" } }, "application/json": { } } } } } } }, "components": { "schemas": { "BundleEntry": { "type": "object", "properties": { "fullUrl": { "type": [ "null", "string" ], "description": "The absolute URL of the resource." }, "resource": { "oneOf": [ { "type": "null" }, { "description": "The Plan-Net resource carried by this entry.", "$ref": "#/components/schemas/PlanNetResource" } ] } }, "description": "A single entry within a Bundle." }, "BundleLink": { "type": "object", "properties": { "relation": { "type": [ "null", "string" ], "description": "The relation type of the link (e.g. \"self\", \"next\")." }, "url": { "type": [ "null", "string" ], "description": "The link URL." } }, "description": "A navigation link within a Bundle." }, "CapabilityImplementation": { "type": "object", "properties": { "description": { "type": [ "null", "string" ], "description": "Human-friendly description of the installation." }, "url": { "type": [ "null", "string" ], "description": "Base URL for the installation." } }, "description": "Details about a specific server installation." }, "CapabilityInteraction": { "type": "object", "properties": { "code": { "type": [ "null", "string" ], "description": "The interaction code (e.g. \"read\", \"search-type\")." } }, "description": "A RESTful interaction supported for a resource type." }, "CapabilityResource": { "type": "object", "properties": { "type": { "type": [ "null", "string" ], "description": "The FHIR resource type name." }, "profile": { "type": [ "null", "string" ], "description": "The profile the published resources conform to." }, "interaction": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityInteraction" }, "description": "The RESTful interactions supported for this resource type." }, "searchParam": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilitySearchParam" }, "description": "The search parameters supported for this resource type." } }, "description": "A resource type published by the server." }, "CapabilityRest": { "type": "object", "properties": { "mode": { "type": [ "null", "string" ], "description": "Whether this describes the client or server role. Always \"server\"." }, "resource": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityResource" }, "description": "The resource types published by this server." } }, "description": "RESTful capabilities of the server." }, "CapabilitySearchParam": { "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "The name of the search parameter (e.g. \"_id\", \"name\")." }, "type": { "type": [ "null", "string" ], "description": "The type of the search parameter (e.g. \"token\", \"date\", \"string\")." } }, "description": "A search parameter supported for a resource type." }, "CapabilityStatement": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"CapabilityStatement\"." }, "status": { "type": [ "null", "string" ], "description": "The publication status of the statement." }, "date": { "type": [ "null", "string" ], "description": "Date the statement was last changed." }, "publisher": { "type": [ "null", "string" ], "description": "Name of the organization responsible for the statement." }, "kind": { "type": [ "null", "string" ], "description": "The way the statement is intended to be used (e.g. \"instance\")." }, "fhirVersion": { "type": [ "null", "string" ], "description": "The FHIR version this server supports." }, "format": { "type": "array", "items": { "type": "string" }, "description": "Formats supported for content exchange." }, "implementation": { "oneOf": [ { "type": "null" }, { "description": "Details about this specific installation.", "$ref": "#/components/schemas/CapabilityImplementation" } ] }, "rest": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityRest" }, "description": "The RESTful capabilities of the server." } }, "description": "A FHIR CapabilityStatement describing what this server publishes." }, "FhirAddress": { "type": "object", "properties": { "text": { "type": [ "null", "string" ], "description": "Text representation of the address." }, "line": { "type": "array", "items": { "type": "string" }, "description": "Street name, number, direction and P.O. Box." }, "city": { "type": [ "null", "string" ], "description": "Name of the city, town, etc." }, "state": { "type": [ "null", "string" ], "description": "Sub-unit of country (e.g. state)." }, "postalCode": { "type": [ "null", "string" ], "description": "Postal code for the area." }, "country": { "type": [ "null", "string" ], "description": "Country." } }, "description": "A postal address." }, "FhirAttachment": { "type": "object", "properties": { "contentType": { "type": [ "null", "string" ], "description": "Mime type of the content, with charset etc." }, "url": { "type": [ "null", "string" ], "description": "Uri where the data can be found." }, "language": { "type": [ "null", "string" ], "description": "Human language of the content (BCP-47)." }, "title": { "type": [ "null", "string" ], "description": "Label to display in place of the data." } }, "description": "Content in a format defined elsewhere (e.g. an image of a practitioner)." }, "FhirAvailableTime": { "type": "object", "properties": { "daysOfWeek": { "type": "array", "items": { "type": "string" }, "description": "Days of the week the times apply to." }, "availableStartTime": { "type": [ "null", "string" ], "description": "The opening time of day." }, "availableEndTime": { "type": [ "null", "string" ], "description": "The closing time of day." } }, "description": "Times the service or practitioner is available at a location." }, "FhirCodeableConcept": { "type": "object", "properties": { "coding": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCoding" }, "description": "Codes defined by a terminology system." }, "text": { "type": [ "null", "string" ], "description": "Plain text representation of the concept." } }, "description": "A concept described by one or more codings plus optional text." }, "FhirCoding": { "type": "object", "properties": { "system": { "type": [ "null", "string" ], "description": "Identity of the terminology system." }, "code": { "type": [ "null", "string" ], "description": "Symbol in syntax defined by the system." }, "display": { "type": [ "null", "string" ], "description": "Representation defined by the system." } }, "description": "A code defined by a terminology system." }, "FhirContactPoint": { "type": "object", "properties": { "system": { "type": [ "null", "string" ], "description": "Telecommunications form (e.g. \"phone\", \"email\")." }, "value": { "type": [ "null", "string" ], "description": "The actual contact point details." }, "use": { "type": [ "null", "string" ], "description": "The purpose of the contact point (e.g. \"work\")." }, "rank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Preference order for use of the contact point.", "format": "int32" } }, "description": "Details for contacting a person or organization by phone, email, etc." }, "FhirExtension": { "type": "object", "properties": { "url": { "type": [ "null", "string" ], "description": "Identifies the meaning of the extension." }, "extension": { "type": "array", "items": { "$ref": "#/components/schemas/FhirExtension" }, "description": "Nested extensions, used by complex extensions." }, "valueString": { "type": [ "null", "string" ], "description": "Value of the extension when it is a string." }, "valueReference": { "oneOf": [ { "type": "null" }, { "description": "Value of the extension when it is a reference.", "$ref": "#/components/schemas/FhirReference" } ] }, "valueCodeableConcept": { "oneOf": [ { "type": "null" }, { "description": "Value of the extension when it is a coded concept.", "$ref": "#/components/schemas/FhirCodeableConcept" } ] } }, "description": "An extension carrying additional Plan-Net data, such as network references." }, "FhirHumanName": { "type": "object", "properties": { "use": { "type": [ "null", "string" ], "description": "The purpose of this name (e.g. \"usual\")." }, "text": { "type": [ "null", "string" ], "description": "Text representation of the full name." }, "family": { "type": [ "null", "string" ], "description": "Family name (surname)." }, "given": { "type": "array", "items": { "type": "string" }, "description": "Given names, including middle names." } }, "description": "A name of a human, with the ability to identify parts and usage." }, "FhirIdentifier": { "type": "object", "properties": { "use": { "type": [ "null", "string" ], "description": "The purpose of this identifier (e.g. \"usual\")." }, "type": { "oneOf": [ { "type": "null" }, { "description": "Description of the identifier type (e.g. \"NPI\").", "$ref": "#/components/schemas/FhirCodeableConcept" } ] }, "system": { "type": [ "null", "string" ], "description": "The namespace for the identifier value." }, "value": { "type": [ "null", "string" ], "description": "The identifier value." } }, "description": "A business identifier, such as an NPI." }, "FhirMeta": { "type": "object", "properties": { "lastUpdated": { "type": [ "null", "string" ], "description": "When the resource was last changed." }, "profile": { "type": "array", "items": { "type": "string" }, "description": "Profiles the resource claims conformance to." } }, "description": "Resource metadata." }, "FhirPeriod": { "type": "object", "properties": { "start": { "type": [ "null", "string" ], "description": "Starting time with inclusive boundary." }, "end": { "type": [ "null", "string" ], "description": "End time with inclusive boundary." } }, "description": "A time period defined by a start and end date/time." }, "FhirReference": { "type": "object", "properties": { "reference": { "type": [ "null", "string" ], "description": "Relative or absolute reference (e.g. \"Organization/abc123\")." }, "display": { "type": [ "null", "string" ], "description": "Text alternative for the resource." } }, "description": "A reference from one resource to another." }, "FileManifest": { "type": "object", "properties": { "transactionTime": { "type": [ "null", "string" ], "description": "The server's time when the listed files were generated." }, "request": { "type": [ "null", "string" ], "description": "The full URL representing the request." }, "requiresAccessToken": { "type": [ "null", "string" ], "description": "Indicates whether downloading the generated files requires a bearer access token." }, "output": { "type": "array", "items": { "$ref": "#/components/schemas/ManifestFileItem" }, "description": "An array of file items with one entry for each generated file." }, "error": { "type": "array", "items": { "$ref": "#/components/schemas/ManifestFileItem" }, "description": "Array of error file items following the same structure as the output array." } }, "description": "The file manifest listing the most-recently generated batch of files\ncontaining provider directory information." }, "HealthcareService": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"HealthcareService\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "extension": { "type": "array", "items": { "$ref": "#/components/schemas/FhirExtension" }, "description": "Plan-Net extensions, including `delivery-method`." }, "active": { "type": [ "null", "boolean" ], "description": "Whether this healthcare service record is in active use." }, "providedBy": { "oneOf": [ { "type": "null" }, { "description": "Reference to the organization that provides this healthcare service.", "$ref": "#/components/schemas/FhirReference" } ] }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "The broad category of the service that may be provided." }, "specialty": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "The specialty associated with the service that may be provided." }, "location": { "type": "array", "items": { "$ref": "#/components/schemas/FhirReference" }, "description": "The location(s) at which this service may be provided." }, "availableTime": { "type": "array", "items": { "$ref": "#/components/schemas/FhirAvailableTime" }, "description": "Times the service is available at the location." } }, "description": "Plan-Net HealthcareService - a service offered at a location by an organization." }, "InsurancePlan": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"InsurancePlan\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FhirIdentifier" }, "description": "Business identifiers, such as the CMS Medicare Advantage plan ID." }, "status": { "type": [ "null", "string" ], "description": "The current state of the health insurance product." }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "The kind of health insurance product (Insurance Product Type VS)." }, "name": { "type": [ "null", "string" ], "description": "Official name of the health insurance product as designated by the owner." }, "period": { "oneOf": [ { "type": "null" }, { "description": "The period the product is available.", "$ref": "#/components/schemas/FhirPeriod" } ] }, "ownedBy": { "oneOf": [ { "type": "null" }, { "description": "The health plan entity that provides the health insurance product.", "$ref": "#/components/schemas/FhirReference" } ] }, "administeredBy": { "oneOf": [ { "type": "null" }, { "description": "The organization that performs administrative tasks on behalf of the owner.", "$ref": "#/components/schemas/FhirReference" } ] }, "network": { "type": "array", "items": { "$ref": "#/components/schemas/FhirReference" }, "description": "References to the networks included in the health insurance product." } }, "description": "Plan-Net InsurancePlan - a health insurance product offered by the plan, and the networks\nit includes." }, "Location": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"Location\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FhirIdentifier" }, "description": "Identifies this location across multiple systems (typically an NPI)." }, "status": { "type": [ "null", "string" ], "description": "The current state of the location." }, "name": { "type": [ "null", "string" ], "description": "Name by which a facility or location is known." }, "mode": { "type": [ "null", "string" ], "description": "Whether the resource represents a specific location or a class of locations." }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "Indicates the type of function performed at the location." }, "specialty": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "The types of services offered at the location." }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/FhirContactPoint" }, "description": "Contact details for the location." }, "address": { "oneOf": [ { "type": "null" }, { "description": "Address for the location.", "$ref": "#/components/schemas/FhirAddress" } ] } }, "description": "Plan-Net Location - a physical place where services are provided." }, "ManifestFileItem": { "type": "object", "properties": { "type": { "type": [ "null", "string" ], "description": "The FHIR resource type contained in the file (e.g. Bundle, Organization, Practitioner).\nOmitted when the upstream index does not convey a type." }, "url": { "type": [ "null", "string" ], "description": "The path to the file." } }, "description": "A single generated file entry in the manifest." }, "Network": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"Organization\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net Network profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "active": { "type": [ "null", "boolean" ], "description": "Whether the network record is still in active use." }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "The kind of organization this is. Always \"ntwk\"." }, "name": { "type": [ "null", "string" ], "description": "The name used for the network." }, "partOf": { "oneOf": [ { "type": "null" }, { "description": "The organization that manages this network.", "$ref": "#/components/schemas/FhirReference" } ] } }, "description": "Plan-Net Network - a specialized Organization resource representing a healthcare provider\ninsurance network. The `type` coding is always \"ntwk\"." }, "OperationOutcome": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"OperationOutcome\"." }, "issue": { "type": "array", "items": { "$ref": "#/components/schemas/OperationOutcomeIssue" }, "description": "The issues encountered while processing the request." } }, "description": "A FHIR OperationOutcome - a collection of error, warning, or information messages that\nresult from a system action. Returned by this API for all non-success responses, matching\nthe FHIR RESTful API error conventions." }, "OperationOutcomeDetails": { "type": "object", "properties": { "text": { "type": [ "null", "string" ], "description": "Human-readable description of the issue." } }, "description": "Additional details about an issue." }, "OperationOutcomeIssue": { "type": "object", "properties": { "severity": { "type": [ "null", "string" ], "description": "Severity of the issue: fatal, error, warning or information." }, "code": { "type": [ "null", "string" ], "description": "Error or warning code describing the type of issue (e.g. \"invalid\", \"not-found\")." }, "details": { "oneOf": [ { "type": "null" }, { "description": "Additional details about the issue.", "$ref": "#/components/schemas/OperationOutcomeDetails" } ] } }, "description": "A single issue associated with the action." }, "Organization": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"Organization\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FhirIdentifier" }, "description": "Identifies this organization across multiple systems (typically an NPI)." }, "active": { "type": [ "null", "boolean" ], "description": "Whether the organization's record is still in active use." }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "The kind of organization this is (Organization Type VS)." }, "name": { "type": [ "null", "string" ], "description": "The name associated with the organization." }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/FhirContactPoint" }, "description": "Contact details for the organization." }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/FhirAddress" }, "description": "Addresses for the organization." } }, "description": "Plan-Net Organization - an organization participating in the provider directory." }, "OrganizationAffiliation": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"OrganizationAffiliation\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "active": { "type": [ "null", "boolean" ], "description": "Whether this organization affiliation record is in active use." }, "participatingOrganization": { "oneOf": [ { "type": "null" }, { "description": "Reference to the organization participating in the network.", "$ref": "#/components/schemas/FhirReference" } ] }, "network": { "type": "array", "items": { "$ref": "#/components/schemas/FhirReference" }, "description": "Networks through which services are offered at the indicated locations." }, "code": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "Defines the role performed by the organization." }, "specialty": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "The types of services offered at the location." }, "location": { "type": "array", "items": { "$ref": "#/components/schemas/FhirReference" }, "description": "The location(s) at which this role is performed." }, "healthcareService": { "type": "array", "items": { "$ref": "#/components/schemas/FhirReference" }, "description": "The healthcare services offered by the organization." } }, "description": "Plan-Net OrganizationAffiliation - the relationship between an organization and the\nnetworks, locations and services through which it participates." }, "PlanNetBundle": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"Bundle\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID of the bundle." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Metadata about the bundle, including when it was last updated.", "$ref": "#/components/schemas/FhirMeta" } ] }, "type": { "type": [ "null", "string" ], "description": "The bundle type (e.g. \"searchset\", \"collection\")." }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Total number of resources represented by the bundle.", "format": "int32" }, "link": { "type": "array", "items": { "$ref": "#/components/schemas/BundleLink" }, "description": "Navigation links (e.g. \"self\", \"next\")." }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/BundleEntry" }, "description": "The resources contained in the bundle." } }, "description": "A FHIR Bundle of provider directory resources returned by the Fetch File endpoint." }, "PlanNetResource": { "type": "object", "properties": { "resourceType": { "type": [ "null", "string" ], "description": "The FHIR resource type (e.g. Organization, Practitioner, Location)." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile the resource conforms to.", "$ref": "#/components/schemas/FhirMeta" } ] }, "active": { "type": [ "null", "boolean" ], "description": "Whether the record is still in active use." }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FhirIdentifier" }, "description": "Business identifiers for the resource (typically an NPI where available)." } }, "description": "Common shape of any Plan-Net resource in a bundle entry. The populated elements depend on\nthe value of `resourceType`; see the resource-specific schemas for details." }, "Practitioner": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"Practitioner\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FhirIdentifier" }, "description": "Identifies this practitioner across multiple systems (typically an NPI)." }, "active": { "type": [ "null", "boolean" ], "description": "Whether the practitioner's record is still in active use." }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/FhirHumanName" }, "description": "The name(s) associated with the practitioner." }, "gender": { "type": [ "null", "string" ], "description": "The gender of the practitioner." }, "communication": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "Languages the practitioner can use in patient communication." }, "photo": { "type": "array", "items": { "$ref": "#/components/schemas/FhirAttachment" }, "description": "Image of the person." }, "qualification": { "type": "array", "items": { "$ref": "#/components/schemas/PractitionerQualification" }, "description": "The practitioner's qualifications." } }, "description": "Plan-Net Practitioner - an individual provider in the directory." }, "PractitionerQualification": { "type": "object", "properties": { "code": { "oneOf": [ { "type": "null" }, { "description": "Coded representation of the qualification.", "$ref": "#/components/schemas/FhirCodeableConcept" } ] }, "period": { "oneOf": [ { "type": "null" }, { "description": "Period during which the qualification is valid.", "$ref": "#/components/schemas/FhirPeriod" } ] }, "issuer": { "oneOf": [ { "type": "null" }, { "description": "The organization that regulates and issues the qualification.", "$ref": "#/components/schemas/FhirReference" } ] } }, "description": "A certification, licence or training pertaining to a practitioner." }, "PractitionerRole": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Always \"PractitionerRole\"." }, "id": { "type": [ "null", "string" ], "description": "FHIR ID." }, "meta": { "oneOf": [ { "type": "null" }, { "description": "Resource metadata, including the Plan-Net profile.", "$ref": "#/components/schemas/FhirMeta" } ] }, "extension": { "type": "array", "items": { "$ref": "#/components/schemas/FhirExtension" }, "description": "Plan-Net extensions, including `newpatients` (accepting patients, from-network and\ncharacteristics) and `network-reference` entries." }, "active": { "type": [ "null", "boolean" ], "description": "Whether this practitioner role record is in active use." }, "period": { "oneOf": [ { "type": "null" }, { "description": "The period during which the practitioner is authorized to perform this role.", "$ref": "#/components/schemas/FhirPeriod" } ] }, "practitioner": { "oneOf": [ { "type": "null" }, { "description": "Reference to the practitioner performing the role.", "$ref": "#/components/schemas/FhirReference" } ] }, "organization": { "oneOf": [ { "type": "null" }, { "description": "Reference to the organization the practitioner performs the role for.", "$ref": "#/components/schemas/FhirReference" } ] }, "specialty": { "type": "array", "items": { "$ref": "#/components/schemas/FhirCodeableConcept" }, "description": "Specialty being practiced by the practitioner in this role." }, "location": { "type": "array", "items": { "$ref": "#/components/schemas/FhirReference" }, "description": "The location(s) at which this practitioner role takes place." }, "healthcareService": { "type": "array", "items": { "$ref": "#/components/schemas/FhirReference" }, "description": "The healthcare services the practitioner provides for this role." }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/FhirContactPoint" }, "description": "Contact details that are specific to the role." }, "availableTime": { "type": "array", "items": { "$ref": "#/components/schemas/FhirAvailableTime" }, "description": "Office hours for the provider, specific to this role." } }, "description": "Plan-Net PractitionerRole - the roles, networks, locations and services through which a\npractitioner delivers care." } } }, "tags": [ { "name": "Bulk Publish", "description": "File manifest (index file) and file download endpoints." }, { "name": "HealthcareService", "description": "Services offered at a location by an organization." }, { "name": "InsurancePlan", "description": "Health insurance products and the networks they include." }, { "name": "Location", "description": "Physical places where services are provided." }, { "name": "Organization", "description": "Participating organizations and provider networks." }, { "name": "OrganizationAffiliation", "description": "Relationships between organizations, networks and locations." }, { "name": "Practitioner", "description": "Individual providers in the directory." }, { "name": "PractitionerRole", "description": "Roles, networks, locations and services for a practitioner." }, { "name": "Bundle", "description": "The Bundle envelope returned for bundle-style publishes." }, { "name": "metadata", "description": "Server capability statement." } ] }