openapi: 3.0.3 info: title: FHIR API version: 1.0.0 description: Formulary and Provider Directory API paths: /formulary/api/List: get: operationId: list_formulary description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: _profile schema: type: string title: ' profile' minLength: 1 description: An URL of profile in structured definition - in: query name: identifier schema: type: string minLength: 1 description: CoveragePlan identifier. It can be in the type of CloverHealth's identifier (E.g. 001, 002) or the plan ID (E.g. H5141) - in: query name: item schema: type: string minLength: 1 description: The identifier of the associated FormularyDrug (also known as MedicationKnowledge) under the CoveragePlan - in: query name: status schema: enum: - current - retired - entered-in-error type: string minLength: 1 description: |- * `current` - current * `retired` - retired * `entered-in-error` - entered-in-error tags: - fhir-r4-formulary-api security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/FormularyListResponse' examples: JSONExample: value: resourceType: Bundle id: 14f5b0a7-2d8b-43fb-a46e-b6c7d92aa59e meta: lastUpdated: '2021-05-27T03:30:14.877Z' type: searchset total: 1 link: - relation: self url: https://public-api.cloverhealth.com/formulary/api/List entry: - fullUrl: https://public-api.cloverhealth.com/formulary/api/List/a1bf521c-7fe0-5329-b1bb-8858a52cd807 search: mode: match resource: resourceType: List id: a1bf521c-7fe0-5329-b1bb-8858a52cd807 meta: lastUpdated: '2021-05-18T10:18:01.162981+00:00' profile: - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan identifier: - system: https://www.cloverhealth.com/plans value: '001' - system: https://www.cloverhealth.com/plans value: '002' - value: H5141 status: current mode: snapshot title: H5141 date: '2021-05-18T10:18:01.162981+00:00' extension: - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: preferred-brand display: 'Preferred Brand: Brand name drugs' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: specialty display: 'Specialty: Drugs used to treat complex conditions like cancer and multiple sclerosis.They can be generic or brand name, and are typically the most expensive drugs on the formulary.' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: non-preferred-generic display: 'Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: generic display: 'Generic: Commonly prescribed generic drugs that cost more than drugs in the ‘preferred generic’ tier.' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: non-preferred-brand display: 'Non-preferred Brand: Brand name drugs that cost more than ‘brand’ drugs.' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension valueString: Not Applicable - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension valueString: https://cdn.cloverhealth.com/filer_public/d0/b6/d0b6294a-2e6b-4504-b9d4-bf65a4753210/76207_nj_eng_ch_nj_cy21_5t_gs_core_april_21.pdf - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension valueString: HIOS-PLAN-ID entry: - item: reference: MedicationKnowledge/000212621243033 - item: reference: MedicationKnowledge/000212621923056 summary: JSON Example description: |2 ListBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/FormularyListResponse' examples: XMLExample: value: |2 <date value="2021-05-18T10:18:01.162981+00:00"/> <entry> <item> <reference value="MedicationKnowledge/000212621243033"/> </item> </entry> <entry> <item> <reference value="MedicationKnowledge/000212621923056"/> </item> </entry> </List> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: |2 ListBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /formulary/api/List/{id}: get: operationId: list_formulary_item description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - fhir-r4-formulary-api security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/FormularyListItemResponse' examples: JSONExample: value: resourceType: List id: a1bf521c-7fe0-5329-b1bb-8858a52cd807 meta: lastUpdated: '2021-05-18T10:18:01.162981+00:00' profile: - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan identifier: - system: https://www.cloverhealth.com/plans value: '001' - system: https://www.cloverhealth.com/plans value: '002' - value: H5141 status: current mode: snapshot title: H5141 date: '2021-05-18T10:18:01.162981+00:00' extension: - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: preferred-generic display: 'Preferred Generic: Commonly prescribed generic drugs.' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: non-preferred-generic display: 'Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension extension: - url: drugTierID valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: non-preferred-brand display: 'Non-preferred Brand: Brand name drugs that cost more than ‘brand’ drugs.' - url: mailOrder valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension valueString: Not Applicable - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension valueString: https://cdn.cloverhealth.com/filer_public/d0/b6/d0b6294a-2e6b-4504-b9d4-bf65a4753210/76207_nj_eng_ch_nj_cy21_5t_gs_core_april_21.pdf - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension valueString: HIOS-PLAN-ID entry: - item: reference: MedicationKnowledge/000212621000001 - item: reference: MedicationKnowledge/000212621000048 summary: JSON Example description: |2 List A list is a curated collection of resources - Rule: A list can only have an emptyReason if it is empty - Rule: The deleted flag can only be used if the mode of the list is "changes" - Rule: An entry date can only be used if the mode of the list is "working" Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/FormularyListItemResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <List xmlns="http://hl7.org/fhir"> <id value="a1bf521c-7fe0-5329-b1bb-8858a52cd807"/> <meta> <lastUpdated value="2021-05-18T10:18:01.162981+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan"/> </meta> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension"> <extension url="drugTierID"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS"/> <code value="preferred-generic"/> <display value="Preferred Generic: Commonly prescribed generic drugs."/> </coding> </valueCodeableConcept> </extension> <extension url="mailOrder"> <valueBoolean value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension"> <extension url="drugTierID"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS"/> <code value="non-preferred-generic"/> <display value="Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier."/> </coding> </valueCodeableConcept> </extension> <extension url="mailOrder"> <valueBoolean value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension"> <extension url="drugTierID"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS"/> <code value="non-preferred-brand"/> <display value="Non-preferred Brand: Brand name drugs that cost more than ‘brand’ drugs."/> </coding> </valueCodeableConcept> </extension> <extension url="mailOrder"> <valueBoolean value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension"> <valueString value="Not Applicable"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension"> <valueString value="https://cdn.cloverhealth.com/filer_public/d0/b6/d0b6294a-2e6b-4504-b9d4-bf65a4753210/76207_nj_eng_ch_nj_cy21_5t_gs_core_april_21.pdf"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension"> <valueString value="HIOS-PLAN-ID"/> </extension> <identifier> <system value="https://www.cloverhealth.com/plans"/> <value value="001"/> </identifier> <identifier> <system value="https://www.cloverhealth.com/plans"/> <value value="002"/> </identifier> <identifier> <value value="H5141"/> </identifier> <status value="current"/> <mode value="snapshot"/> <title value="H5141"/> <date value="2021-05-18T10:18:01.162981+00:00"/> <entry> <item> <reference value="MedicationKnowledge/000212621000001"/> </item> </entry> <entry> <item> <reference value="MedicationKnowledge/000212621000048"/> </item> </entry> </List> summary: XML Example description: |2 List A list is a curated collection of resources - Rule: A list can only have an emptyReason if it is empty - Rule: The deleted flag can only be used if the mode of the list is "changes" - Rule: An entry date can only be used if the mode of the list is "working" Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /formulary/api/MedicationKnowledge: get: operationId: search_medication_knowledge description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: DrugName schema: type: string minLength: 1 description: Name of the drug - in: query name: DrugPlan schema: type: string minLength: 1 description: Plan of the drug - in: query name: DrugTier schema: type: string minLength: 1 description: Drug tier of the drug - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: _profile schema: type: string title: ' profile' minLength: 1 description: An URL of profile in structured definition - in: query name: code schema: type: string minLength: 1 description: Rx code of the drug tags: - fhir-r4-formulary-api security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/FormularyMedicationKnowledgeResponse' examples: JSONExample: value: resourceType: Bundle id: 2f6e91d0-60ea-41b6-96cb-354ec38697ad meta: lastUpdated: '2021-05-27T12:10:37.416+08:00' type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge entry: - fullUrl: https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge/000211871000001 resource: resourceType: MedicationKnowledge id: 000211871000001 meta: profile: - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug text: status: generated div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS preferred-generic}">Preferred Generic: Commonly prescribed generic drugs.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: true</p><p><b>Plan ID</b>: H5141</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000001}">OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG</span></p></div>' extension: - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: preferred-generic display: 'Preferred Generic: Commonly prescribed generic drugs.' - system: https://www.cloverhealth.com/members/formulary/DrugTierLevel code: Tier 1 display: Preferred Generic drugs - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension valueBoolean: false - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension valueBoolean: false - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension valueString: H5141 - url: https://www.cloverhealth.com/members/formulary valueString: 00021187 code: coding: - system: http://www.nlm.nih.gov/research/umls/rxnorm code: '1000001' display: OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG search: mode: match - fullUrl: https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge/000211871000048 resource: resourceType: MedicationKnowledge id: 000211871000048 meta: profile: - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug text: status: generated div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS non-preferred-generic}">Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: false</p><p><b>Plan ID</b>: H8010</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000048}">DOXEPIN HCL CAP 10 MG</span></p></div>' extension: - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: non-preferred-generic display: 'Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.' - system: https://www.cloverhealth.com/members/formulary/DrugTierLevel code: Tier 4 display: Non-Preferred drugs - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension valueBoolean: false - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension valueBoolean: false - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension valueBoolean: false - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension valueString: H8010 - url: https://www.cloverhealth.com/members/formulary valueString: 00021187 code: coding: - system: http://www.nlm.nih.gov/research/umls/rxnorm code: '1000048' display: DOXEPIN HCL CAP 10 MG search: mode: match summary: JSON Example description: |2 MedicationKnowledgeBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/FormularyMedicationKnowledgeResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="81938911-5263-4dd4-8400-cd6ee0074c91"/> <meta> <lastUpdated value="2021-05-27T12:11:16.631+08:00"/> </meta> <type value="searchset"/> <total value="2"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge/000211871000001"/> <resource> <MedicationKnowledge xmlns="http://hl7.org/fhir"> <id value="000211871000001"/> <meta> <lastUpdated value="2021-05-27T12:11:16.626+08:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS preferred-generic}">Preferred Generic: Commonly prescribed generic drugs.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: true</p><p><b>Plan ID</b>: H5141</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000001}">OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG</span></p></div></div> </text> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS"/> <code value="preferred-generic"/> <display value="Preferred Generic: Commonly prescribed generic drugs."/> </coding> <coding> <system value="https://www.cloverhealth.com/members/formulary/DrugTierLevel"/> <code value="Tier 1"/> <display value="Preferred Generic drugs"/> </coding> </valueCodeableConcept> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension"> <valueBoolean value="false"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension"> <valueBoolean value="false"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension"> <valueBoolean value="true"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension"> <valueString value="H5141"/> </extension> <extension url="https://www.cloverhealth.com/members/formulary"> <valueString value="00021187"/> </extension> <code> <coding> <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/> <code value="1000001"/> <display value="OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG"/> </coding> </code> </MedicationKnowledge> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge/000211871000048"/> <resource> <MedicationKnowledge xmlns="http://hl7.org/fhir"> <id value="000211871000048"/> <meta> <lastUpdated value="2021-05-27T12:11:16.632+08:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS non-preferred-generic}">Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: false</p><p><b>Plan ID</b>: H8010</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000048}">DOXEPIN HCL CAP 10 MG</span></p></div></div> </text> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS"/> <code value="non-preferred-generic"/> <display value="Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier."/> </coding> <coding> <system value="https://www.cloverhealth.com/members/formulary/DrugTierLevel"/> <code value="Tier 4"/> <display value="Non-Preferred drugs"/> </coding> </valueCodeableConcept> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension"> <valueBoolean value="false"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension"> <valueBoolean value="false"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension"> <valueBoolean value="false"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension"> <valueString value="H8010"/> </extension> <extension url="https://www.cloverhealth.com/members/formulary"> <valueString value="00021187"/> </extension> <code> <coding> <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/> <code value="1000048"/> <display value="DOXEPIN HCL CAP 10 MG"/> </coding> </code> </MedicationKnowledge> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: |2 MedicationKnowledgeBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /formulary/api/MedicationKnowledge/{id}: get: operationId: get_medication_knowledge description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - fhir-r4-formulary-api security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/FormularyMedicationKnowledgeItemResponse' examples: JSONExample: value: resourceType: MedicationKnowledge id: 000211871000001 meta: profile: - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug text: status: generated div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS preferred-generic}">Preferred Generic: Commonly prescribed generic drugs.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: true</p><p><b>Plan ID</b>: H8010</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000001}">OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG</span></p></div>' extension: - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS code: preferred-generic display: 'Preferred Generic: Commonly prescribed generic drugs.' - system: https://www.cloverhealth.com/members/formulary/DrugTierLevel code: Tier 1 display: Preferred Generic drugs - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension valueBoolean: false - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension valueBoolean: false - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension valueBoolean: true - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension valueString: H8010 - url: https://www.cloverhealth.com/members/formulary valueString: 00021187 code: coding: - system: http://www.nlm.nih.gov/research/umls/rxnorm code: '1000001' display: OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG summary: JSON Example description: |- MedicationKnowledge Definition of Medication Knowledge Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/FormularyMedicationKnowledgeItemResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <MedicationKnowledge xmlns="http://hl7.org/fhir"> <id value="000211871000001"/> <meta> <lastUpdated value="2021-05-27T12:11:51.038+08:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS preferred-generic}">Preferred Generic: Commonly prescribed generic drugs.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: true</p><p><b>Plan ID</b>: H8010</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000001}">OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG</span></p></div></div> </text> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS"/> <code value="preferred-generic"/> <display value="Preferred Generic: Commonly prescribed generic drugs."/> </coding> <coding> <system value="https://www.cloverhealth.com/members/formulary/DrugTierLevel"/> <code value="Tier 1"/> <display value="Preferred Generic drugs"/> </coding> </valueCodeableConcept> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension"> <valueBoolean value="false"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension"> <valueBoolean value="false"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension"> <valueBoolean value="true"/> </extension> <extension url="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension"> <valueString value="H8010"/> </extension> <extension url="https://www.cloverhealth.com/members/formulary"> <valueString value="00021187"/> </extension> <code> <coding> <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/> <code value="1000001"/> <display value="OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG"/> </coding> </code> </MedicationKnowledge> summary: XML Example description: |- MedicationKnowledge Definition of Medication Knowledge Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /formulary/api/metadata: get: operationId: get_formulary_api_metadata description: Get the capability statement of the formulary API summary: Get the capability statement of the formulary API tags: - fhir-r4-formulary-api security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/FHIRCapabilityStatement' examples: JSONExample: value: resourceType: CapabilityStatement id: usdf-server text: status: additional div: '<div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">USDFServerCapabilityStatement</h2> <p>This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined. </p> <table> <tr> <td>Mode:</td> <td>SERVER</td> </tr> <tr> <td>Description:</td> <td>The US Drug Formulary Server **SHALL**: <ol> <li>Support the US Drug Formulary CoveragePlan (List) and FormularyDrug (MedicationKnowledge) resource profile.</li> <li>Implement the RESTful behavior according to the FHIR specification.</li> <li>Return the following response classes: <ul> <li>(Status 400): invalid parameter</li> <li>(Status 401/4xx): unauthorized request</li> <li>(Status 403): insufficient scope</li> <li>Status 404): unknown resource</li> <li>(Status 410): deleted resource</li> </ul> </li> <li>Support json source formats for all US Drug Formulary interactions.</li> </ol> </td> </tr> <tr> <td> </td> <td> The US Drug Formulary Server **SHOULD**: <ol> <li>Support xml source formats for all US Drug Formulary interactions.</li> </ol> </td></tr> <tr> <td> </td> <td>The US Drug Formulary Server supports the following transactions: <ul> <li>CoveragePlan (List) Resource <ul> <li>**SHALL**: search-type, read, </li> <li>**SHOULD** : vread, history-instance</li> <li>**MAY** : create, update, patch, delete, history-type</li> </ul> </li> <li>FormularyDrug (MedicationKnowledge) Resource <ul> <li>**SHALL**: search-type, read, </li> <li>**SHOULD** : vread, history-instance</li> <li>**MAY** : create, update, patch, delete, history-type</li> </ul> </li> </ul> </td> </tr> <tr> <td> </td> <td>The US Drug Formulary Server **SHALL** support the following searchParameters individually and in combination: <ul> <li>FormularyDrug (MedicationKnowledge) Resource <ul> <li>DrugName </li> <li>DrugPlan </li> <li>DrugTier </li> <li>code</li> </ul> </li> </ul> </td> </tr> </table> </div>' version: 1.0.0 status: active date: '2020-01-08T00:00:00+10:00' publisher: Clover Health description: 'This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined. ' kind: instance software: name: Clover Health FHIR R4 Formulary API version: 4.2.0 implementation: description: DaVinci PDex US Drug Formulary url: https://build.fhir.org/ig/HL7/davinci-pdex-formulary/ fhirVersion: 4.0.1 format: - application/fhir+xml - application/fhir+json rest: - mode: server resource: - type: Bundle profile: http://hl7.org/fhir/StructureDefinition/Bundle interaction: - code: read - type: List profile: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan interaction: - code: read - code: search-type searchParam: - name: _profile type: string documentation: An URL of profile in structured definition - name: _count type: number documentation: Maximum number of results to be returned - name: identifier type: string documentation: CoveragePlan identifier. It can be in the type of CloverHealth's identifier (E.g. 001, 002) or the plan ID (E.g. H5141) - name: status type: string - name: item type: string documentation: The identifier of the associated FormularyDrug (also known as MedicationKnowledge) under the CoveragePlan - type: MedicationKnowledge profile: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug interaction: - code: read - code: search-type searchParam: - name: _profile type: string documentation: An URL of profile in structured definition - name: _count type: number documentation: Maximum number of results to be returned - name: DrugName type: string documentation: Name of the drug - name: DrugPlan type: string documentation: Plan of the drug - name: DrugTier type: token documentation: Drug tier of the drug - name: code type: string documentation: Rx code of the drug summary: JSON Example description: |- Any instance of data is allowed. The API file specifies body for this request but it does not specify the data model. application/fhir+xml: schema: $ref: '#/components/schemas/FHIRCapabilityStatement' examples: XMLExample: value: |- <?xml version='1.0' encoding='utf-8'?> <CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="usdf-server"/> <text> <status value="additional"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2 id="title">USDFServerCapabilityStatement</h2> <p>This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined. </p> <table> <tr> <td>Mode:</td> <td>SERVER</td> </tr> <tr> <td>Description:</td> <td> The US Drug Formulary Server **SHALL**: <ol> <li>Support the US Drug Formulary CoveragePlan (List) and FormularyDrug (MedicationKnowledge) resource profile.</li> <li>Implement the RESTful behavior according to the FHIR specification.</li> <li> Return the following response classes: <ul> <li>(Status 400): invalid parameter</li> <li>(Status 401/4xx): unauthorized request</li> <li>(Status 403): insufficient scope</li> <li>Status 404): unknown resource</li> <li>(Status 410): deleted resource</li> </ul> </li> <li>Support json source formats for all US Drug Formulary interactions.</li> </ol> </td> </tr> <tr> <td> </td> <td> The US Drug Formulary Server **SHOULD**: <ol> <li>Support xml source formats for all US Drug Formulary interactions.</li> </ol> </td> </tr> <tr> <td> </td> <td> The US Drug Formulary Server supports the following transactions: <ul> <li> CoveragePlan (List) Resource <ul> <li>**SHALL**: search-type, read, </li> <li>**SHOULD** : vread, history-instance</li> <li>**MAY** : create, update, patch, delete, history-type</li> </ul> </li> <li> FormularyDrug (MedicationKnowledge) Resource <ul> <li>**SHALL**: search-type, read, </li> <li>**SHOULD** : vread, history-instance</li> <li>**MAY** : create, update, patch, delete, history-type</li> </ul> </li> </ul> </td> </tr> <tr> <td> </td> <td> The US Drug Formulary Server **SHALL** support the following searchParameters individually and in combination: <ul> <li> FormularyDrug (MedicationKnowledge) Resource <ul> <li>DrugName </li> <li>DrugPlan </li> <li>DrugTier </li> <li>code</li> </ul> </li> </ul> </td> </tr> </table> </div> </text> <version value="1.0.0"/> <status value="active"/> <date value="2020-01-08T00:00:00+10:00"/> <publisher value="Clover Health"/> <description value="This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined. "/> <kind value="instance"/> <software> <name value="Clover Health FHIR R4 Formulary API"/> <version value="4.2.0"/> </software> <implementation> <description value="DaVinci PDex US Drug Formulary"/> <url value="https://build.fhir.org/ig/HL7/davinci-pdex-formulary/"/> </implementation> <fhirVersion value="4.0.1"/> <format value="application/fhir+xml"/> <format value="application/fhir+json"/> <rest> <mode value="server"/> <resource> <type value="Bundle"/> <profile value="http://hl7.org/fhir/StructureDefinition/Bundle"/> <interaction> <code value="read"/> </interaction> </resource> <resource> <type value="List"/> <profile value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="_profile"/> <type value="string"/> <documentation value="An URL of profile in structured definition"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> <documentation value="Maximum number of results to be returned"/> </searchParam> <searchParam> <name value="identifier"/> <type value="string"/> <documentation value="CoveragePlan identifier. It can be in the type of CloverHealth's identifier (E.g. 001, 002) or the plan ID (E.g. H5141)"/> </searchParam> <searchParam> <name value="status"/> <type value="string"/> </searchParam> <searchParam> <name value="item"/> <type value="string"/> <documentation value="The identifier of the associated FormularyDrug (also known as MedicationKnowledge) under the CoveragePlan"/> </searchParam> </resource> <resource> <type value="MedicationKnowledge"/> <profile value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="_profile"/> <type value="string"/> <documentation value="An URL of profile in structured definition"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> <documentation value="Maximum number of results to be returned"/> </searchParam> <searchParam> <name value="DrugName"/> <type value="string"/> <documentation value="Name of the drug"/> </searchParam> <searchParam> <name value="DrugPlan"/> <type value="string"/> <documentation value="Plan of the drug"/> </searchParam> <searchParam> <name value="DrugTier"/> <type value="token"/> <documentation value="Drug tier of the drug"/> </searchParam> <searchParam> <name value="code"/> <type value="string"/> <documentation value="Rx code of the drug"/> </searchParam> </resource> </rest> </CapabilityStatement> summary: XML Example description: |- Any instance of data is allowed. The API file specifies body for this request but it does not specify the data model. description: '' /providerdirectory/api/Endpoint: get: operationId: search_endpoint description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _include schema: enum: - Endpoint:organization type: string title: ' include' minLength: 1 description: |- Return resources related to the search results (E.g. Endpoint:organization) * `Endpoint:organization` - Endpoint:organization - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: organization schema: type: string minLength: 1 description: Select Endpoints managed by the specified organization tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/EndpointSearchResponse' examples: JSONExample: value: resourceType: Bundle id: 58704f4b-b975-4357-aa25-54eeb0083bc5 meta: lastUpdated: '2021-06-11T07:58:26.312Z' profile: - http://hl7.org/fhir/StructureDefinition/Bundle type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/providerdirectory/api/Endpoint entry: - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/6d179858-2560-5ec6-a162-2205ab32f378 resource: resourceType: Endpoint id: 6d179858-2560-5ec6-a162-2205ab32f378 meta: lastUpdated: '2021-06-10T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint status: active connectionType: system: http://terminology.hl7.org/CodeSystem/endpoint-connection-type code: hl7-fhir-rest managingOrganization: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 payloadType: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS code: NA address: https://public-api.cloverhealth.com/providerdirectory/api/Location search: mode: match - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/d440e938-30ab-5d46-8005-5ba41160e098 resource: resourceType: Endpoint id: d440e938-30ab-5d46-8005-5ba41160e098 meta: lastUpdated: '2021-06-10T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint status: active connectionType: system: http://terminology.hl7.org/CodeSystem/endpoint-connection-type code: hl7-fhir-rest managingOrganization: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 payloadType: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS code: NA address: https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole search: mode: match summary: JSON Example description: |2- EndpointBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/EndpointSearchResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="decd7fe7-9e5f-4c9d-bfc4-d0243c601834"/> <meta> <lastUpdated value="2022-12-29T04:00:56.159Z"/> <profile value="http://hl7.org/fhir/StructureDefinition/Bundle"/> </meta> <type value="searchset"/> <total value="2"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/providerdirectory/api/Endpoint"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/6d179858-2560-5ec6-a162-2205ab32f378"/> <resource> <Endpoint xmlns="http://hl7.org/fhir"> <id value="6d179858-2560-5ec6-a162-2205ab32f378"/> <meta> <lastUpdated value="2022-12-25T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint"/> </meta> <status value="active"/> <connectionType> <system value="http://terminology.hl7.org/CodeSystem/endpoint-connection-type"/> <code value="hl7-fhir-rest"/> </connectionType> <managingOrganization> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </managingOrganization> <payloadType> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS"/> <code value="NA"/> </coding> </payloadType> <address value="https://public-api.cloverhealth.com/providerdirectory/api/Location"/> </Endpoint> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/d440e938-30ab-5d46-8005-5ba41160e098"/> <resource> <Endpoint xmlns="http://hl7.org/fhir"> <id value="d440e938-30ab-5d46-8005-5ba41160e098"/> <meta> <lastUpdated value="2022-12-25T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint"/> </meta> <status value="active"/> <connectionType> <system value="http://terminology.hl7.org/CodeSystem/endpoint-connection-type"/> <code value="hl7-fhir-rest"/> </connectionType> <managingOrganization> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </managingOrganization> <payloadType> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS"/> <code value="NA"/> </coding> </payloadType> <address value="https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole"/> </Endpoint> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: |2- EndpointBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/Endpoint/{id}: get: operationId: get_endpoint description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/EndpointGetResponse' examples: JSONExample: value: resourceType: Endpoint id: 6d179858-2560-5ec6-a162-2205ab32f378 meta: lastUpdated: '2021-06-10T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint status: active connectionType: system: http://terminology.hl7.org/CodeSystem/endpoint-connection-type code: hl7-fhir-rest managingOrganization: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 payloadType: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS code: NA address: https://public-api.cloverhealth.com/providerdirectory/api/Location summary: JSON Example description: |2- Endpoint The technical details of an endpoint that can be used for electronic services Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/EndpointGetResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Endpoint xmlns="http://hl7.org/fhir"> <id value="6d179858-2560-5ec6-a162-2205ab32f378"/> <meta> <lastUpdated value="2022-12-25T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint"/> </meta> <status value="active"/> <connectionType> <system value="http://terminology.hl7.org/CodeSystem/endpoint-connection-type"/> <code value="hl7-fhir-rest"/> </connectionType> <managingOrganization> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </managingOrganization> <payloadType> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS"/> <code value="NA"/> </coding> </payloadType> <address value="https://public-api.cloverhealth.com/providerdirectory/api/Location"/> </Endpoint> summary: XML Example description: |2- Endpoint The technical details of an endpoint that can be used for electronic services Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /providerdirectory/api/HealthcareService: get: operationId: search_healthcare_service description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _include schema: enum: - HealthcareService:location - HealthcareService:coverage-area - HealthcareService:organization - HealthcareService:endpoint type: string title: ' include' minLength: 1 description: |- Include resources related to the search results Supported(HealthcareService:location, HealthcareService:coverage-area, HealthcareService:organization, HealthcareService:endpoint) * `HealthcareService:location` - HealthcareService:location * `HealthcareService:coverage-area` - HealthcareService:coverage-area * `HealthcareService:organization` - HealthcareService:organization * `HealthcareService:endpoint` - HealthcareService:endpoint - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: _revinclude schema: enum: - PractitionerRole:service - OrganizationAffiliation:service type: string title: ' revinclude' minLength: 1 description: |- Include resource includes this location Supported(PractitionerRole:service, OrganizationAffiliation:service) * `PractitionerRole:service` - PractitionerRole:service * `OrganizationAffiliation:service` - OrganizationAffiliation:service - in: query name: coverage-area schema: type: string minLength: 1 description: The coverage area of the Healthcare Service - in: query name: identifier schema: type: string minLength: 1 description: NPI for the Healthcare Service - in: query name: location schema: type: string minLength: 1 description: The location of the Healthcare Service - in: query name: name schema: type: string minLength: 1 description: A portion of the Healthcare service name - in: query name: organization schema: type: string minLength: 1 description: The identity of the organization the healthcare service belong to. - in: query name: service-category schema: type: string minLength: 1 description: Service Category of the Healthcare Service - in: query name: service-type schema: type: string minLength: 1 description: Service Type of the Healthcare Service - in: query name: specialty schema: type: string minLength: 1 description: Specialty of the Healthcare Service tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/HealthcareServiceSearchResponse' examples: JSONExample: value: resourceType: Bundle id: f686a47e-d199-4071-98e0-16891cd2cd55 meta: lastUpdated: '2022-12-30T04:30:36.982Z' type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService entry: - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c05-d3c7-5094-8ac3-fea55830942d resource: resourceType: HealthcareService id: 00001c05-d3c7-5094-8ac3-fea55830942d meta: lastUpdated: '2022-12-25T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService identifier: - value: '1144513540' system: http://hl7.org/fhir/sid/us-npi active: true extension: - extension: - url: type valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method category: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS code: prov type: - coding: - system: http://terminology.hl7.org/CodeSystem/service-type code: '349' location: - reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44 name: Moyosoye Folayan Oyeyinka telecom: - extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary valueReference: reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44 specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 207R00000X search: mode: match - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c2f-35a7-5118-bb2c-3756317fa0db resource: resourceType: HealthcareService id: 00001c2f-35a7-5118-bb2c-3756317fa0db meta: lastUpdated: '2022-12-25T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService identifier: - value: '1952337263' system: http://hl7.org/fhir/sid/us-npi active: true extension: - extension: - url: type valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method category: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS code: outpat type: - coding: - system: http://terminology.hl7.org/CodeSystem/service-type code: '335' location: - reference: Location/c263b088-f3e8-5114-9971-0e8ff6226c74 providedBy: reference: Organization/54b466ed-7ea1-59d0-9437-2afe7354470d name: South Texas Rural Health Services Inc telecom: - extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary valueReference: reference: Location/c263b088-f3e8-5114-9971-0e8ff6226c74 specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 261QM1300X search: mode: match summary: JSON Example description: |- HealthcareServiceBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/HealthcareServiceSearchResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="df0b9553-ba8d-4c7e-ae45-3c8c0eb89f7e"/> <meta> <lastUpdated value="2022-12-30T04:30:46.642Z"/> </meta> <type value="searchset"/> <total value="2"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c05-d3c7-5094-8ac3-fea55830942d"/> <resource> <HealthcareService> <id value="00001c05-d3c7-5094-8ac3-fea55830942d"/> <meta> <lastUpdated value="2022-12-25T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService"/> </meta> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method"> <extension url="type"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS"/> <code value="physical"/> </coding> </valueCodeableConcept> </extension> </extension> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1144513540"/> </identifier> <active value="true"/> <category> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS"/> <code value="prov"/> </coding> </category> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/service-type"/> <code value="349"/> </coding> </type> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="3336C0004X"/> <display value="Compounding Pharmacy"/> </coding> </specialty> <location> <reference value="Location/e1578c9c-a885-5bed-9263-60b92fea4b44"/> </location> <name value="Moyosoye Folayan Oyeyinka"/> <telecom> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary"> <valueReference> <reference value="Location/e1578c9c-a885-5bed-9263-60b92fea4b44"/> </valueReference> </extension> </telecom> </HealthcareService> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c2f-35a7-5118-bb2c-3756317fa0db"/> <resource> <HealthcareService> <id value="00001c2f-35a7-5118-bb2c-3756317fa0db"/> <meta> <lastUpdated value="2022-12-25T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService"/> </meta> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method"> <extension url="type"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS"/> <code value="physical"/> </coding> </valueCodeableConcept> </extension> </extension> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1952337263"/> </identifier> <active value="true"/> <providedBy> <reference value="Organization/54b466ed-7ea1-59d0-9437-2afe7354470d"/> </providedBy> <category> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS"/> <code value="outpat"/> </coding> </category> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/service-type"/> <code value="335"/> </coding> </type> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="3336C0004X"/> <display value="Compounding Pharmacy"/> </coding> </specialty> <location> <reference value="Location/c263b088-f3e8-5114-9971-0e8ff6226c74"/> </location> <name value="South Texas Rural Health Services Inc"/> <telecom> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary"> <valueReference> <reference value="Location/c263b088-f3e8-5114-9971-0e8ff6226c74"/> </valueReference> </extension> </telecom> </HealthcareService> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: |- HealthcareServiceBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/HealthcareService/{id}: get: operationId: get_healthcare_service description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/HealthcareServiceGetResponse' examples: JSONExample: value: resourceType: HealthcareService id: 00001c05-d3c7-5094-8ac3-fea55830942d meta: lastUpdated: '2022-12-25T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService identifier: - value: '1144513540' system: http://hl7.org/fhir/sid/us-npi active: true extension: - extension: - url: type valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method category: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS code: prov type: - coding: - system: http://terminology.hl7.org/CodeSystem/service-type code: '349' location: - reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44 name: Moyosoye Folayan Oyeyinka telecom: - extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary valueReference: reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44 specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 207R00000X summary: JSON Example description: |- HealthcareService The details of a healthcare service available at a location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/HealthcareServiceGetResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <HealthcareService> <id value="00001c05-d3c7-5094-8ac3-fea55830942d"/> <meta> <lastUpdated value="2022-12-25T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService"/> </meta> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method"> <extension url="type"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS"/> <code value="physical"/> </coding> </valueCodeableConcept> </extension> </extension> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1144513540"/> </identifier> <active value="true"/> <category> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS"/> <code value="prov"/> </coding> </category> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/service-type"/> <code value="349"/> </coding> </type> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="3336C0004X"/> <display value="Compounding Pharmacy"/> </coding> </specialty> <location> <reference value="Location/e1578c9c-a885-5bed-9263-60b92fea4b44"/> </location> <name value="Moyosoye Folayan Oyeyinka"/> <telecom> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary"> <valueReference> <reference value="Location/e1578c9c-a885-5bed-9263-60b92fea4b44"/> </valueReference> </extension> </telecom> </HealthcareService> summary: XML Example description: |- HealthcareService The details of a healthcare service available at a location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /providerdirectory/api/InsurancePlan: get: operationId: search_insurance_plan description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _include schema: enum: - InsurancePlan:administered-by - InsurancePlan:owned-by - InsurancePlan:coverage-area type: string title: ' include' minLength: 1 description: |- Include resources related to the search results Supported(InsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-area) * `InsurancePlan:administered-by` - InsurancePlan:administered-by * `InsurancePlan:owned-by` - InsurancePlan:owned-by * `InsurancePlan:coverage-area` - InsurancePlan:coverage-area - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: administered-by schema: type: string minLength: 1 description: The organization that administer the plan. - in: query name: coverage-area schema: type: string minLength: 1 description: The coverage area of the plan. - in: query name: identifier schema: type: string minLength: 1 description: Clover Healthc plan id. - in: query name: name schema: type: string minLength: 1 description: A portion of the plan name - in: query name: network schema: type: string minLength: 1 description: The network of the plan - in: query name: owned-by schema: type: string minLength: 1 description: An organization that owns the plan. - in: query name: type schema: type: string minLength: 1 description: The type of the plan. tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/InsurancePlanSearchResponse' examples: JSONExample: value: resourceType: Bundle id: 9db60664-0830-4308-8463-25aee122b0e9 meta: lastUpdated: '2023-01-04T02:41:05.527Z' type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan entry: - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan/1a18601c-8d0d-516b-98c0-d2b2e22333ef resource: resourceType: InsurancePlan id: 1a18601c-8d0d-516b-98c0-d2b2e22333ef meta: lastUpdated: '2023-01-01T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan identifier: - system: https://www.cloverhealth.com/plans value: '025' status: active type: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS code: mediadv ownedBy: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 administeredBy: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 network: - reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 coverageArea: - reference: Location/0168d57c-c36a-5fd3-b75f-ee126728d852 - reference: Location/40e711c5-c4c0-57db-a36e-17eb48c5d49e - reference: Location/415eddd7-40aa-5bd9-aa31-07be1eb01225 - reference: Location/43d6521e-d2d4-5968-8b94-15a43030e027 - reference: Location/7e6f3e39-1e5c-52e8-b860-6b882dcb10af - reference: Location/be5c8d0c-893f-5b27-8501-6b1f6ea8685a - reference: Location/f03c0028-4e46-5adb-b39b-0b83efe8d9a6 name: Clover Health Choice (PPO) search: mode: match - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan/2017b48f-bb3f-5c13-9499-eed6f0c68049 resource: resourceType: InsurancePlan id: 2017b48f-bb3f-5c13-9499-eed6f0c68049 meta: lastUpdated: '2023-01-01T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan identifier: - system: https://www.cloverhealth.com/plans value: '007' status: active type: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS code: mediadv ownedBy: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 administeredBy: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 network: - reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 coverageArea: - reference: Location/2ca7813e-9c8a-5dc5-90cd-e5c17020dc82 - reference: Location/3b619aa6-e10f-5530-8282-a3965a8d668a - reference: Location/43f446d2-0507-53ad-9ce9-7621343f168e - reference: Location/481e6ae8-1961-59a5-8e5f-8231fdf31fc5 - reference: Location/51d056a7-2dbf-520c-ad85-6d9e2233be43 - reference: Location/646dfb92-f112-5261-98aa-689a0cb4f7ec - reference: Location/98181050-9066-5ae8-a21c-fc356931d502 - reference: Location/a284c28a-b5b5-532a-8eda-9b74a9825b04 - reference: Location/a38eb4f4-1696-582b-a3f9-afd430932521 - reference: Location/c24b5a32-ac0b-5bb9-a60b-4021970fbeae - reference: Location/cc5549d6-68ef-5565-80f0-941bea2cc482 - reference: Location/d5a0240f-1a2d-51a2-bc37-1bcbe748c3e7 name: Clover Health Choice Value (PPO) search: mode: match summary: JSON Example description: | InsurancePlanBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/InsurancePlanSearchResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="8fbdd40b-6ac5-44c0-ba09-a41ee30fa2b0"/> <meta> <lastUpdated value="2023-01-04T02:40:33.766Z"/> </meta> <type value="searchset"/> <total value="2"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan/1a18601c-8d0d-516b-98c0-d2b2e22333ef"/> <resource> <InsurancePlan> <id value="1a18601c-8d0d-516b-98c0-d2b2e22333ef"/> <meta> <lastUpdated value="2023-01-01T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan"/> </meta> <identifier> <system value="https://www.cloverhealth.com/plans"/> <value value="025"/> </identifier> <status value="active"/> <type> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS"/> <code value="mediadv"/> </coding> </type> <name value="Clover Health Choice (PPO)"/> <ownedBy> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </ownedBy> <administeredBy> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </administeredBy> <coverageArea> <reference value="Location/0168d57c-c36a-5fd3-b75f-ee126728d852"/> </coverageArea> <coverageArea> <reference value="Location/40e711c5-c4c0-57db-a36e-17eb48c5d49e"/> </coverageArea> <coverageArea> <reference value="Location/415eddd7-40aa-5bd9-aa31-07be1eb01225"/> </coverageArea> <coverageArea> <reference value="Location/43d6521e-d2d4-5968-8b94-15a43030e027"/> </coverageArea> <coverageArea> <reference value="Location/7e6f3e39-1e5c-52e8-b860-6b882dcb10af"/> </coverageArea> <coverageArea> <reference value="Location/be5c8d0c-893f-5b27-8501-6b1f6ea8685a"/> </coverageArea> <coverageArea> <reference value="Location/f03c0028-4e46-5adb-b39b-0b83efe8d9a6"/> </coverageArea> <network> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </network> </InsurancePlan> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan/2017b48f-bb3f-5c13-9499-eed6f0c68049"/> <resource> <InsurancePlan> <id value="2017b48f-bb3f-5c13-9499-eed6f0c68049"/> <meta> <lastUpdated value="2023-01-01T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan"/> </meta> <identifier> <system value="https://www.cloverhealth.com/plans"/> <value value="007"/> </identifier> <status value="active"/> <type> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS"/> <code value="mediadv"/> </coding> </type> <name value="Clover Health Choice Value (PPO)"/> <ownedBy> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </ownedBy> <administeredBy> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </administeredBy> <coverageArea> <reference value="Location/2ca7813e-9c8a-5dc5-90cd-e5c17020dc82"/> </coverageArea> <coverageArea> <reference value="Location/3b619aa6-e10f-5530-8282-a3965a8d668a"/> </coverageArea> <coverageArea> <reference value="Location/43f446d2-0507-53ad-9ce9-7621343f168e"/> </coverageArea> <coverageArea> <reference value="Location/481e6ae8-1961-59a5-8e5f-8231fdf31fc5"/> </coverageArea> <coverageArea> <reference value="Location/51d056a7-2dbf-520c-ad85-6d9e2233be43"/> </coverageArea> <coverageArea> <reference value="Location/646dfb92-f112-5261-98aa-689a0cb4f7ec"/> </coverageArea> <coverageArea> <reference value="Location/98181050-9066-5ae8-a21c-fc356931d502"/> </coverageArea> <coverageArea> <reference value="Location/a284c28a-b5b5-532a-8eda-9b74a9825b04"/> </coverageArea> <coverageArea> <reference value="Location/a38eb4f4-1696-582b-a3f9-afd430932521"/> </coverageArea> <coverageArea> <reference value="Location/c24b5a32-ac0b-5bb9-a60b-4021970fbeae"/> </coverageArea> <coverageArea> <reference value="Location/cc5549d6-68ef-5565-80f0-941bea2cc482"/> </coverageArea> <coverageArea> <reference value="Location/d5a0240f-1a2d-51a2-bc37-1bcbe748c3e7"/> </coverageArea> <network> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </network> </InsurancePlan> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: | InsurancePlanBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/InsurancePlan/{id}: get: operationId: get_insurance_plan description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/InsurancePlanGetResponse' examples: JSONExample: value: resourceType: InsurancePlan id: 1a18601c-8d0d-516b-98c0-d2b2e22333ef meta: lastUpdated: '2023-01-01T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan identifier: - system: https://www.cloverhealth.com/plans value: '025' status: active type: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS code: mediadv ownedBy: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 administeredBy: reference: Organization/c6672acb-ea60-5431-802d-c637901772d3 network: - reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 coverageArea: - reference: Location/0168d57c-c36a-5fd3-b75f-ee126728d852 - reference: Location/40e711c5-c4c0-57db-a36e-17eb48c5d49e - reference: Location/415eddd7-40aa-5bd9-aa31-07be1eb01225 - reference: Location/43d6521e-d2d4-5968-8b94-15a43030e027 - reference: Location/7e6f3e39-1e5c-52e8-b860-6b882dcb10af - reference: Location/be5c8d0c-893f-5b27-8501-6b1f6ea8685a - reference: Location/f03c0028-4e46-5adb-b39b-0b83efe8d9a6 name: Clover Health Choice (PPO) summary: JSON Example description: |- InsurancePlan Details of a Health Insurance product/plan provided by an organization. - Rule: The organization SHALL at least have a name or an idendtifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/InsurancePlanGetResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <InsurancePlan> <id value="1a18601c-8d0d-516b-98c0-d2b2e22333ef"/> <meta> <lastUpdated value="2023-01-01T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan"/> </meta> <identifier> <system value="https://www.cloverhealth.com/plans"/> <value value="025"/> </identifier> <status value="active"/> <type> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS"/> <code value="mediadv"/> </coding> </type> <name value="Clover Health Choice (PPO)"/> <ownedBy> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </ownedBy> <administeredBy> <reference value="Organization/c6672acb-ea60-5431-802d-c637901772d3"/> </administeredBy> <coverageArea> <reference value="Location/0168d57c-c36a-5fd3-b75f-ee126728d852"/> </coverageArea> <coverageArea> <reference value="Location/40e711c5-c4c0-57db-a36e-17eb48c5d49e"/> </coverageArea> <coverageArea> <reference value="Location/415eddd7-40aa-5bd9-aa31-07be1eb01225"/> </coverageArea> <coverageArea> <reference value="Location/43d6521e-d2d4-5968-8b94-15a43030e027"/> </coverageArea> <coverageArea> <reference value="Location/7e6f3e39-1e5c-52e8-b860-6b882dcb10af"/> </coverageArea> <coverageArea> <reference value="Location/be5c8d0c-893f-5b27-8501-6b1f6ea8685a"/> </coverageArea> <coverageArea> <reference value="Location/f03c0028-4e46-5adb-b39b-0b83efe8d9a6"/> </coverageArea> <network> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </network> </InsurancePlan> summary: XML Example description: |- InsurancePlan Details of a Health Insurance product/plan provided by an organization. - Rule: The organization SHALL at least have a name or an idendtifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /providerdirectory/api/Location: get: operationId: search_location description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _include schema: enum: - Location:endpoint - Location:organization - Location:partof type: string title: ' include' minLength: 1 description: |- Include resources related to the search results Supported(Location:organization, Location:partof) * `Location:endpoint` - Location:endpoint * `Location:organization` - Location:organization * `Location:partof` - Location:partof - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: _revinclude schema: enum: - HealthcareService:location - InsurancePlan:coverage-area - OrganizationAffiliation:location - PractitionerRole:location type: string title: ' revinclude' minLength: 1 description: |- Include resource includes this location Supported(HealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location) * `HealthcareService:location` - HealthcareService:location * `InsurancePlan:coverage-area` - InsurancePlan:coverage-area * `OrganizationAffiliation:location` - OrganizationAffiliation:location * `PractitionerRole:location` - PractitionerRole:location - in: query name: address schema: type: string minLength: 1 description: A (part of the) address of the location - in: query name: address-city schema: type: string minLength: 1 description: A city specified in an address - in: query name: address-postalcode schema: type: string minLength: 1 description: A state specified in an address - in: query name: address-state schema: type: string minLength: 1 description: A postalCode specified in an address - in: query name: name schema: type: string minLength: 1 description: Name of the location - in: query name: near schema: type: string description: Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also - in: query name: organization schema: type: string minLength: 1 description: The identity of the organization the location belong to. - in: query name: partof schema: type: string minLength: 1 description: The id of the location that the matched one is physically part of. - in: query name: type schema: type: string minLength: 1 description: The type of the location. tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/LocationSearchResponse' examples: JSONExample: value: resourceType: Bundle id: 82dfaff0-fa91-4522-a566-a7c91dcf3500 meta: lastUpdated: '2021-06-14T16:35:52.135Z' type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/providerdirectory/api/Location entry: - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Location/00003100-fe74-568b-b7c8-47db031b508d resource: resourceType: Location id: 00003100-fe74-568b-b7c8-47db031b508d meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">WALGREENS</div> status: active name: WALGREENS type: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-RoleCode code: PHARM telecom: - system: phone value: 615-781-6489 use: work address: line: - 5429 Nolensville Pike city: Nashville state: TN postalCode: '37211' position: longitude: -86.71516 latitude: 36.04969 partOf: reference: Location/2938bd9d-9c51-5fe7-a2ed-62247ddc7c8f search: mode: match - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Location/0000997d-a1d5-5bad-94d9-6d0823863b76 resource: resourceType: Location id: 0000997d-a1d5-5bad-94d9-6d0823863b76 meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">Chattanooga Hamilton County Hospital Authority</div> status: active name: Chattanooga Hamilton County Hospital Authority type: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-RoleCode code: HOSP telecom: - system: phone value: '4237782867' use: work address: line: - 979 E 3rd St Ste A440 city: Chattanooga state: TN postalCode: '37403' position: longitude: -85.29039 latitude: 35.0478 managingOrganization: reference: Organization/216fed38-1f68-552a-9e24-db0b52fd9d71 partOf: reference: Location/cf2e814e-8393-5d56-bb32-33fdb45b1f97 search: mode: match summary: JSON Example description: | LocationBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/LocationSearchResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="6d0462fd-e880-40ca-b622-89ca129fc7f9"/> <meta> <lastUpdated value="2022-12-23T06:56:22.662Z"/> </meta> <type value="searchset"/> <total value="20"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/providerdirectory/api/Location"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/00002659-1327-5f46-8286-a28876d34c8d"/> <resource> <Location> <id value="00002659-1327-5f46-8286-a28876d34c8d"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Atlantic Physical Therapy Center</div> </text> <status value="active"/> <name value="Atlantic Physical Therapy Center"/> <telecom> <system value="phone"/> <value value="732-440-1596"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="732-440-1597"/> <use value="work"/> </telecom> <address> <line value="1131 Broad St Ste 301"/> <city value="Shrewsbury"/> <state value="NJ"/> <postalCode value="07702"/> </address> <position> <longitude value="-74.062150"/> <latitude value="40.318150"/> </position> <managingOrganization> <reference value="Organization/79a17b32-dac0-599c-866b-0f54c1c1c1a8"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/00003100-fe74-568b-b7c8-47db031b508d"/> <resource> <Location> <id value="00003100-fe74-568b-b7c8-47db031b508d"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">WALGREENS</div> </text> <status value="active"/> <name value="WALGREENS"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="615-781-6489"/> <use value="work"/> </telecom> <address> <line value="5429 Nolensville Pike"/> <city value="Nashville"/> <state value="TN"/> <postalCode value="37211"/> </address> <position> <longitude value="-86.713940"/> <latitude value="36.049580"/> </position> <partOf> <reference value="Location/2938bd9d-9c51-5fe7-a2ed-62247ddc7c8f"/> </partOf> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0000acec-c5d3-500e-97ed-e1e946001d10"/> <resource> <Location> <id value="0000acec-c5d3-500e-97ed-e1e946001d10"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Labcorp</div> </text> <status value="active"/> <name value="Labcorp"/> <telecom> <system value="phone"/> <value value="541-234-2411"/> <use value="work"/> </telecom> <address> <line value="355 W 3rd Ave"/> <city value="Junction City"/> <state value="OR"/> <postalCode value="97448"/> </address> <position> <longitude value="-123.204230"/> <latitude value="44.216490"/> </position> <managingOrganization> <reference value="Organization/2ac0728f-646b-5e80-be8f-a72198cc7b8c"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0000b326-3040-5712-b7ac-d701850e8acf"/> <resource> <Location> <id value="0000b326-3040-5712-b7ac-d701850e8acf"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">University of Penn Medical Group</div> </text> <status value="active"/> <name value="University of Penn Medical Group"/> <telecom> <system value="phone"/> <value value="215-662-8060"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="215-243-3284"/> <use value="work"/> </telecom> <address> <line value="51 N 39th St Ste 106 Medical Arts Building"/> <city value="Philadelphia"/> <state value="PA"/> <postalCode value="19104"/> </address> <position> <longitude value="-75.200040"/> <latitude value="39.958440"/> </position> <managingOrganization> <reference value="Organization/6ff43946-1c46-5b1f-bb8a-bdc8c71351ca"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0000c76f-eac8-5cb7-a5a1-ebe2d0c2570f"/> <resource> <Location> <id value="0000c76f-eac8-5cb7-a5a1-ebe2d0c2570f"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">BAY AREA PHARMACY</div> </text> <status value="active"/> <name value="BAY AREA PHARMACY"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="813-221-3131"/> <use value="work"/> </telecom> <address> <line value="10549 N Florida Ave Ste A"/> <city value="Tampa"/> <state value="FL"/> <postalCode value="33612"/> </address> <position> <longitude value="-82.459320"/> <latitude value="28.046380"/> </position> <partOf> <reference value="Location/91b55b31-bb93-56a5-9c66-536d0570a2c0"/> </partOf> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/00012acd-42ad-5a3b-bff4-d085b1995a15"/> <resource> <Location> <id value="00012acd-42ad-5a3b-bff4-d085b1995a15"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">FARMACIA MORELL CORP</div> </text> <status value="active"/> <name value="FARMACIA MORELL CORP"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="787-898-3045"/> <use value="work"/> </telecom> <address> <line value="Ave Munoz Rivera #1 Oeste"/> <city value="Camuy"/> <state value="PR"/> <postalCode value="00627"/> </address> <position> <longitude value="-66.846480"/> <latitude value="18.485140"/> </position> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/000174bc-faf4-575c-8962-0941e72d319a"/> <resource> <Location> <id value="000174bc-faf4-575c-8962-0941e72d319a"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">CVS PHARMACY</div> </text> <status value="active"/> <name value="CVS PHARMACY"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="860-296-1155"/> <use value="work"/> </telecom> <address> <line value="690 Wethersfield Ave"/> <city value="Hartford"/> <state value="CT"/> <postalCode value="06114"/> </address> <position> <longitude value="-72.670810"/> <latitude value="41.736660"/> </position> <partOf> <reference value="Location/5ae5beda-354d-5cdc-bd39-180662891398"/> </partOf> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0001cd20-cde1-5caa-957e-541e645df6c8"/> <resource> <Location> <id value="0001cd20-cde1-5caa-957e-541e645df6c8"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Chestnut Hill Temple Cardiology</div> </text> <status value="active"/> <name value="Chestnut Hill Temple Cardiology"/> <telecom> <system value="phone"/> <value value="215-233-9700"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="215-233-9710"/> <use value="work"/> </telecom> <address> <line value="1722 Bethlehem Pike"/> <city value="Flourtown"/> <state value="PA"/> <postalCode value="19031"/> </address> <position> <longitude value="-75.213540"/> <latitude value="40.107900"/> </position> <managingOrganization> <reference value="Organization/6fbdecd2-9cf4-5495-a3f9-7862e287a0b5"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0001f025-896f-500e-ae04-f117364964d0"/> <resource> <Location> <id value="0001f025-896f-500e-ae04-f117364964d0"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">RITE AID PHARMACY</div> </text> <status value="active"/> <name value="RITE AID PHARMACY"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="734-425-9721"/> <use value="work"/> </telecom> <address> <line value="33251 Plymouth Rd"/> <city value="Livonia"/> <state value="MI"/> <postalCode value="48150"/> </address> <position> <longitude value="-83.371530"/> <latitude value="42.368160"/> </position> <partOf> <reference value="Location/0e2e6cc2-3e92-57b6-815d-34bdff4aecf8"/> </partOf> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0002ae88-ac9e-564e-8e6c-dd4db13af152"/> <resource> <Location> <id value="0002ae88-ac9e-564e-8e6c-dd4db13af152"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">New Jersey Imaging Network</div> </text> <status value="active"/> <name value="New Jersey Imaging Network"/> <telecom> <system value="phone"/> <value value="732-476-6515"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="732-476-6516"/> <use value="work"/> </telecom> <address> <line value="10 Parsonage Rd"/> <city value="Edison"/> <state value="NJ"/> <postalCode value="08837"/> </address> <position> <longitude value="-74.331490"/> <latitude value="40.546890"/> </position> <managingOrganization> <reference value="Organization/da086186-aa95-58f4-ad2c-b4b8461ad755"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0002cbe0-557b-5d2a-9ab5-6de88306a28a"/> <resource> <Location> <id value="0002cbe0-557b-5d2a-9ab5-6de88306a28a"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Forest Hill Physical Therapy LLC</div> </text> <status value="active"/> <name value="Forest Hill Physical Therapy LLC"/> <telecom> <system value="phone"/> <value value="973-485-4766"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="973-732-1141"/> <use value="work"/> </telecom> <address> <line value="465 Mount Prospect Ave"/> <city value="Newark"/> <state value="NJ"/> <postalCode value="07104"/> </address> <position> <longitude value="-74.169530"/> <latitude value="40.767360"/> </position> <managingOrganization> <reference value="Organization/e6848681-9640-5663-bdb6-90c5ffcceced"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/00030649-b1a1-5c84-b287-cc06e4a749fd"/> <resource> <Location> <id value="00030649-b1a1-5c84-b287-cc06e4a749fd"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Roper St Francis Physician Partners Neurosurgery and Spine</div> </text> <status value="active"/> <name value="Roper St Francis Physician Partners Neurosurgery and Spine"/> <telecom> <system value="phone"/> <value value="843-723-8823"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="843-606-8059"/> <use value="work"/> </telecom> <address> <line value="2145 Henry Tecklenburg Dr Ste 220"/> <city value="Charleston"/> <state value="SC"/> <postalCode value="29414"/> </address> <position> <longitude value="-80.061180"/> <latitude value="32.816220"/> </position> <managingOrganization> <reference value="Organization/ac587c99-7816-50d2-a38c-d2fde5865e8b"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/00033369-bb1c-5760-8449-b60d0582dbb1"/> <resource> <Location> <id value="00033369-bb1c-5760-8449-b60d0582dbb1"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">BHS Physicians Network Inc</div> </text> <status value="active"/> <name value="BHS Physicians Network Inc"/> <telecom> <system value="phone"/> <value value="210-640-1646"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="210-640-1647"/> <use value="work"/> </telecom> <address> <line value="430 W Sunset Rd Ste 115"/> <city value="San Antonio"/> <state value="TX"/> <postalCode value="78209"/> </address> <position> <longitude value="-98.474780"/> <latitude value="29.507460"/> </position> <managingOrganization> <reference value="Organization/da471cb6-a225-55a5-966a-02dbf90f6f43"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/00034673-b487-5699-a709-39fe4077cb89"/> <resource> <Location> <id value="00034673-b487-5699-a709-39fe4077cb89"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Vineville Internal Medicine Llc</div> </text> <status value="active"/> <name value="Vineville Internal Medicine Llc"/> <telecom> <system value="phone"/> <value value="478-405-0045"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="478-405-0054"/> <use value="work"/> </telecom> <address> <line value="3448 Vineville Ave"/> <city value="Macon"/> <state value="GA"/> <postalCode value="31204"/> </address> <position> <longitude value="-83.682350"/> <latitude value="32.857470"/> </position> <managingOrganization> <reference value="Organization/37f5e17e-5802-58e7-b7aa-d7244e64507c"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/000367ee-634d-593e-894c-abf4609dbf38"/> <resource> <Location> <id value="000367ee-634d-593e-894c-abf4609dbf38"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">J&M PHARMACY</div> </text> <status value="active"/> <name value="J&M PHARMACY"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="917-396-4794"/> <use value="work"/> </telecom> <address> <line value="8507 Roosevelt Ave"/> <city value="Jackson Heights"/> <state value="NY"/> <postalCode value="11372"/> </address> <position> <longitude value="-73.880540"/> <latitude value="40.748230"/> </position> <partOf> <reference value="Location/26814431-67cc-5f9a-bfe3-5b16d9528569"/> </partOf> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/000393c3-974d-58f2-b698-6e9b9b722996"/> <resource> <Location> <id value="000393c3-974d-58f2-b698-6e9b9b722996"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Tidelands Georgetown Memorial Hospital</div> </text> <status value="active"/> <name value="Tidelands Georgetown Memorial Hospital"/> <telecom> <system value="phone"/> <value value="843-652-8240"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="843-652-8249"/> <use value="work"/> </telecom> <address> <line value="4040 Highway 17"/> <city value="Murrells Inlet"/> <state value="SC"/> <postalCode value="29576"/> </address> <position> <longitude value="-79.041170"/> <latitude value="33.559950"/> </position> <managingOrganization> <reference value="Organization/57084c4e-a8df-5cc9-981a-d6f861d29469"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0003b968-e3de-576e-889c-9abc1a4396c4"/> <resource> <Location> <id value="0003b968-e3de-576e-889c-9abc1a4396c4"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Associated Retinal Consultants LLC</div> </text> <status value="active"/> <name value="Associated Retinal Consultants LLC"/> <telecom> <system value="phone"/> <value value="732-389-2333"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="732-389-2788"/> <use value="work"/> </telecom> <address> <line value="2 Industrial Way W"/> <city value="Eatontown"/> <state value="NJ"/> <postalCode value="07724"/> </address> <position> <longitude value="-74.049080"/> <latitude value="40.276060"/> </position> <managingOrganization> <reference value="Organization/4ed121f7-16e9-5256-9c86-7996b4de35c1"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0003c65d-7f19-5b04-bf4f-3c5594dbe20c"/> <resource> <Location> <id value="0003c65d-7f19-5b04-bf4f-3c5594dbe20c"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">First Chiropractic - 22nd St Llc</div> </text> <status value="active"/> <name value="First Chiropractic - 22nd St Llc"/> <telecom> <system value="phone"/> <value value="520-886-4213"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="520-298-9693"/> <use value="work"/> </telecom> <address> <line value="8560 E 22nd St Ste 100"/> <city value="Tucson"/> <state value="AZ"/> <postalCode value="85710"/> </address> <position> <longitude value="-110.809570"/> <latitude value="32.206310"/> </position> <managingOrganization> <reference value="Organization/ed00e86c-a70c-5fae-9001-f3732bc62bf4"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/000431b6-fda3-586d-b756-caef6427a154"/> <resource> <Location> <id value="000431b6-fda3-586d-b756-caef6427a154"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Professional Occupational And Physical Therapy Pllc</div> </text> <status value="active"/> <name value="Professional Occupational And Physical Therapy Pllc"/> <telecom> <system value="phone"/> <value value="201-992-0182"/> <use value="work"/> </telecom> <telecom> <system value="fax"/> <value value="201-765-9434"/> <use value="work"/> </telecom> <address> <line value="668 Wyckoff Ave"/> <city value="Wyckoff"/> <state value="NJ"/> <postalCode value="07481"/> </address> <position> <longitude value="-74.172010"/> <latitude value="41.012900"/> </position> <managingOrganization> <reference value="Organization/3cb83eea-2081-5c8d-bf2a-f42d703dad6d"/> </managingOrganization> </Location> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Location/0004c22b-e9e2-5888-aaad-1c36bc6fdd9a"/> <resource> <Location> <id value="0004c22b-e9e2-5888-aaad-1c36bc6fdd9a"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">WALGREENS</div> </text> <status value="active"/> <name value="WALGREENS"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="718-821-2678"/> <use value="work"/> </telecom> <address> <line value="355 Knickerbocker Ave"/> <city value="Brooklyn"/> <state value="NY"/> <postalCode value="11237"/> </address> <position> <longitude value="-73.921900"/> <latitude value="40.700940"/> </position> <partOf> <reference value="Location/250203ab-3160-50d3-a963-bec5efbf9cf9"/> </partOf> </Location> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: | LocationBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/Location/{id}: get: operationId: get_location description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/LocationGetResponse' examples: JSONExample: value: resourceType: Location id: 00003100-fe74-568b-b7c8-47db031b508d meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">WALGREENS</div> status: active name: WALGREENS type: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-RoleCode code: PHARM telecom: - system: phone value: 615-781-6489 use: work address: line: - 5429 Nolensville Pike city: Nashville state: TN postalCode: '37211' position: longitude: -86.71516 latitude: 36.04969 partOf: reference: Location/2938bd9d-9c51-5fe7-a2ed-62247ddc7c8f summary: JSON Example description: | Location Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. application/fhir+xml: schema: $ref: '#/components/schemas/LocationGetResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Location> <id value="000367ee-634d-593e-894c-abf4609dbf38"/> <meta> <lastUpdated value="2022-12-18T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">J&M PHARMACY</div> </text> <status value="active"/> <name value="J&M PHARMACY"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="PHARM"/> </coding> </type> <telecom> <system value="phone"/> <value value="917-396-4794"/> <use value="work"/> </telecom> <address> <line value="8507 Roosevelt Ave"/> <city value="Jackson Heights"/> <state value="NY"/> <postalCode value="11372"/> </address> <position> <longitude value="-73.880540"/> <latitude value="40.748230"/> </position> <partOf> <reference value="Location/26814431-67cc-5f9a-bfe3-5b16d9528569"/> </partOf> </Location> summary: XML Example description: | Location Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. description: '' /providerdirectory/api/Organization: get: operationId: search_organization description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _include schema: enum: - Organization:partof - Organization:endpoint - Organization:coverage-area type: string title: ' include' minLength: 1 description: |- Return resources related to the search results (E.g. Organization:partof, Organization:endpoint and Organization:coverage-area (Not effective)) * `Organization:partof` - Organization:partof * `Organization:endpoint` - Organization:endpoint * `Organization:coverage-area` - Organization:coverage-area - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: _revinclude schema: enum: - Endpoint:organization - HealthcareService:organization - InsurancePlan:administered-by - InsurancePlan:owned-by - OrganizationAffiliation:primary-organization - OrganizationAffiliation:participating-organization - PractitionerRole:organization - PractitionerRole:network type: string title: ' revinclude' minLength: 1 description: |- Return resources filtered by the search results (E.g. Endpoint:Organization, HealthcareService:organization, InsurancePlan:administered-by (Not effective), InsurancePlan:owned-by (Not effective), PractitionerRole:organization, PractitionerRole:network, OrganizationAffiliation:primary-organization, OrganizationAffiliation:participating-organization) * `Endpoint:organization` - Endpoint:organization * `HealthcareService:organization` - HealthcareService:organization * `InsurancePlan:administered-by` - InsurancePlan:administered-by * `InsurancePlan:owned-by` - InsurancePlan:owned-by * `OrganizationAffiliation:primary-organization` - OrganizationAffiliation:primary-organization * `OrganizationAffiliation:participating-organization` - OrganizationAffiliation:participating-organization * `PractitionerRole:organization` - PractitionerRole:organization * `PractitionerRole:network` - PractitionerRole:network - in: query name: address schema: type: string minLength: 1 description: Select organizations with the specified address (matches any of the string elements of an address) (case insensitive) - in: query name: coverage-area schema: type: string minLength: 1 description: (Not effective due to lack of data) Select health insurance provider networks available in a region described by the specified location - in: query name: endpoint schema: type: string minLength: 1 description: Select organizations with the specified endpoint (in terms of endpoint ID) - in: query name: name schema: type: string minLength: 1 description: Select organizations with the specified name (matches any of portion of the name) (case insensitive) - in: query name: partof schema: type: string minLength: 1 description: Select organizations that are part of the organization (in terms of organization ID) - in: query name: type schema: type: string minLength: 1 description: Select organizations of the specified type (E.g. fac, prvgrp, ins, ntwk) tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/OrganizationSearchResponse' examples: JSONExample: value: resourceType: Bundle id: e2100c91-eb92-48ff-8bd6-4bee39c5156d meta: lastUpdated: '2021-06-11T00:48:03.465+08:00' profile: - http://hl7.org/fhir/StructureDefinition/Bundle type: searchset total: 1 link: - relation: self url: https://public-api.cloverhealth.com/providerdirectory/api/Organization entry: - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Organization/c6672acb-ea60-5431-802d-c637901772d3 resource: resourceType: Organization id: c6672acb-ea60-5431-802d-c637901772d3 meta: lastUpdated: '2021-06-10T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization active: true type: - coding: - system: http://terminology.hl7.org/CodeSystem/organization-type code: ins name: Clover Health telecom: - system: phone value: 1-800-836-6890 (TTY 711) endpoint: - reference: Endpoint/6d179858-2560-5ec6-a162-2205ab32f378 - reference: Endpoint/d440e938-30ab-5d46-8005-5ba41160e098 - reference: Endpoint/d0ad6fdc-e3c3-5e4e-9e58-ba03f0890acf - reference: Endpoint/6de7294f-0c82-58b3-aa63-ed25a48e71eb - reference: Endpoint/4e9e6ab5-acf5-568b-b186-c81a81f9f859 - reference: Endpoint/0dfc6e13-bb9f-562c-8954-35c426feea0b - reference: Endpoint/8fcc05e9-2b5d-59be-86af-2fc0b4910ce0 - reference: Endpoint/ea64c0b3-b041-51cd-9ac8-b9f230cccfa7 search: mode: match summary: JSON Example description: |- OrganizationBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/OrganizationSearchResponse' examples: XMLExample: value: | <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="895a63d5-d16a-431a-911c-c1bc3afd2424"/> <meta> <lastUpdated value="2021-06-11T03:45:30.227Z"/> <profile value="http://hl7.org/fhir/StructureDefinition/Bundle"/> </meta> <type value="searchset"/> <total value="1"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/providerdirectory/api/Organization"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/Organization/c6672acb-ea60-5431-802d-c637901772d3"/> <resource> <Organization xmlns="http://hl7.org/fhir"> <id value="c6672acb-ea60-5431-802d-c637901772d3"/> <meta> <lastUpdated value="2021-06-10T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization"/> </meta> <active value="true"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/organization-type"/> <code value="ins"/> </coding> </type> <name value="Clover Health"/> <telecom> <system value="phone"/> <value value="1-800-836-6890 (TTY 711)"/> </telecom> <endpoint> <reference value="Endpoint/6d179858-2560-5ec6-a162-2205ab32f378"/> </endpoint> <endpoint> <reference value="Endpoint/d440e938-30ab-5d46-8005-5ba41160e098"/> </endpoint> <endpoint> <reference value="Endpoint/d0ad6fdc-e3c3-5e4e-9e58-ba03f0890acf"/> </endpoint> <endpoint> <reference value="Endpoint/6de7294f-0c82-58b3-aa63-ed25a48e71eb"/> </endpoint> <endpoint> <reference value="Endpoint/4e9e6ab5-acf5-568b-b186-c81a81f9f859"/> </endpoint> <endpoint> <reference value="Endpoint/0dfc6e13-bb9f-562c-8954-35c426feea0b"/> </endpoint> <endpoint> <reference value="Endpoint/8fcc05e9-2b5d-59be-86af-2fc0b4910ce0"/> </endpoint> <endpoint> <reference value="Endpoint/ea64c0b3-b041-51cd-9ac8-b9f230cccfa7"/> </endpoint> </Organization> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: |- OrganizationBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/Organization/{id}: get: operationId: get_organization description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/OrganizationGetResponse' examples: JSONExample: value: resourceType: Organization id: c6672acb-ea60-5431-802d-c637901772d3 meta: lastUpdated: '2021-06-10T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization active: true type: - coding: - system: http://terminology.hl7.org/CodeSystem/organization-type code: ins name: Clover Health telecom: - system: phone value: 1-800-836-6890 (TTY 711) endpoint: - reference: Endpoint/6d179858-2560-5ec6-a162-2205ab32f378 - reference: Endpoint/d440e938-30ab-5d46-8005-5ba41160e098 - reference: Endpoint/d0ad6fdc-e3c3-5e4e-9e58-ba03f0890acf - reference: Endpoint/6de7294f-0c82-58b3-aa63-ed25a48e71eb - reference: Endpoint/4e9e6ab5-acf5-568b-b186-c81a81f9f859 - reference: Endpoint/0dfc6e13-bb9f-562c-8954-35c426feea0b - reference: Endpoint/8fcc05e9-2b5d-59be-86af-2fc0b4910ce0 - reference: Endpoint/ea64c0b3-b041-51cd-9ac8-b9f230cccfa7 summary: JSON Example description: | Organization This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. Example Usage Scenarios: The following are example usage scenarios for the US Core-Organization profile: Query by organization name or NPI Mandatory and Must Support Data Elements The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements. Each Organization must have: A status of the organization A name Each Organization must support: An identifier National Provider Identifier (NPI) for organizations Clinical Laboratory Improvement Amendments (CLIA) for laboratories. A list of contact information Profile specific implementation guidance: none Examples Organization-acme-lab Organization-with-EndPoint Formal Views of Profile Content Description of Profiles, Differentials, and Snapshots. A grouping of people or organizations with a common purpose - Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/OrganizationGetResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Organization xmlns="http://hl7.org/fhir"> <id value="c6672acb-ea60-5431-802d-c637901772d3"/> <meta> <lastUpdated value="2021-06-10T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization"/> </meta> <active value="true"/> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/organization-type"/> <code value="ins"/> </coding> </type> <name value="Clover Health"/> <telecom> <system value="phone"/> <value value="1-800-836-6890 (TTY 711)"/> </telecom> <endpoint> <reference value="Endpoint/6d179858-2560-5ec6-a162-2205ab32f378"/> </endpoint> <endpoint> <reference value="Endpoint/d440e938-30ab-5d46-8005-5ba41160e098"/> </endpoint> <endpoint> <reference value="Endpoint/d0ad6fdc-e3c3-5e4e-9e58-ba03f0890acf"/> </endpoint> <endpoint> <reference value="Endpoint/6de7294f-0c82-58b3-aa63-ed25a48e71eb"/> </endpoint> <endpoint> <reference value="Endpoint/4e9e6ab5-acf5-568b-b186-c81a81f9f859"/> </endpoint> <endpoint> <reference value="Endpoint/0dfc6e13-bb9f-562c-8954-35c426feea0b"/> </endpoint> <endpoint> <reference value="Endpoint/8fcc05e9-2b5d-59be-86af-2fc0b4910ce0"/> </endpoint> <endpoint> <reference value="Endpoint/ea64c0b3-b041-51cd-9ac8-b9f230cccfa7"/> </endpoint> </Organization> summary: XML Example description: | Organization This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. Example Usage Scenarios: The following are example usage scenarios for the US Core-Organization profile: Query by organization name or NPI Mandatory and Must Support Data Elements The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements. Each Organization must have: A status of the organization A name Each Organization must support: An identifier National Provider Identifier (NPI) for organizations Clinical Laboratory Improvement Amendments (CLIA) for laboratories. A list of contact information Profile specific implementation guidance: none Examples Organization-acme-lab Organization-with-EndPoint Formal Views of Profile Content Description of Profiles, Differentials, and Snapshots. A grouping of people or organizations with a common purpose - Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /providerdirectory/api/OrganizationAffiliation: get: operationId: search_organization_affiliation description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _include schema: enum: - OrganizationAffiliation:primary-organization - OrganizationAffiliation:participating-organization - OrganizationAffiliation:location - OrganizationAffiliation:service - OrganizationAffiliation:endpoint - OrganizationAffiliation:network type: string title: ' include' minLength: 1 description: |- Return resources related to the search results (E.g. OrganizationAffiliation:location, OrganizationAffiliation:service, OrganizationAffiliation:network and OrganizationAffiliation:endpoint (Not effective)) * `OrganizationAffiliation:primary-organization` - OrganizationAffiliation:primary-organization * `OrganizationAffiliation:participating-organization` - OrganizationAffiliation:participating-organization * `OrganizationAffiliation:location` - OrganizationAffiliation:location * `OrganizationAffiliation:service` - OrganizationAffiliation:service * `OrganizationAffiliation:endpoint` - OrganizationAffiliation:endpoint * `OrganizationAffiliation:network` - OrganizationAffiliation:network - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: endpoint schema: type: string minLength: 1 description: (Not effective) Select OrganizationAffiliations with the specified endpoint - in: query name: location schema: type: string minLength: 1 description: Select OrganizationAffiliations available at the specified location (in terms of location ID) - in: query name: network schema: type: string minLength: 1 description: Select roles where the organization is a member of the specified health insurance provider network (in terms of organization ID) - in: query name: participating-organization schema: type: string minLength: 1 description: Select roles filled by the specified organization (in terms of organization ID) - in: query name: primary-organization schema: type: string minLength: 1 description: Select roles offered by the specified organization (in terms of organization ID) - in: query name: role schema: type: string minLength: 1 description: Select OrganizationAffiliations with the specified role code - in: query name: service schema: type: string minLength: 1 description: Select OrganizationAffiliations providing the specified service (in terms of healthcare service ID) - in: query name: specialty schema: type: string minLength: 1 description: Select OrganizationAffiliations associated with the specified specialty code tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/OrganizationAffiliationSearchResponse' examples: JSONExample: value: resourceType: Bundle id: a3c5d710-1777-4cef-a27b-85b52adde720 meta: lastUpdated: '2021-06-11T08:15:57.387Z' profile: - http://hl7.org/fhir/StructureDefinition/Bundle type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation entry: - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation/aefac026-bbfc-5545-b6d6-21d30063ae02 resource: resourceType: OrganizationAffiliation id: aefac026-bbfc-5545-b6d6-21d30063ae02 meta: lastUpdated: '2021-06-11T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation active: true period: start: '2013-01-01' organization: reference: Organization/d9110c8e-2f8a-5966-b52b-0e08aab0767c display: University Physician Associates of New Jersey Inc participatingOrganization: reference: Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d display: ARMEHTAMD PAINANDDISABILITYINSTITUTE PC network: - reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 code: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS code: bt specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 208100000X location: - reference: Location/a5454e38-857d-5f3e-b1a7-0b917b563762 - reference: Location/686d41ce-6486-5e13-b211-23417e86a8b9 healthcareService: - reference: HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368 search: mode: match - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation/9d9c8b8a-c490-5dd1-b550-f5b0d1b4fc3a resource: resourceType: OrganizationAffiliation id: 9d9c8b8a-c490-5dd1-b550-f5b0d1b4fc3a meta: lastUpdated: '2021-06-11T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation active: true period: start: '2018-03-21' organization: reference: Organization/09f01493-5f3a-5db0-afaf-e8b789371e7c display: University Rehabilitation Associates participatingOrganization: reference: Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d display: ARMEHTAMD PAINANDDISABILITYINSTITUTE PC network: - reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 code: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS code: bt specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 208100000X location: - reference: Location/e33dd5aa-613e-5731-ad69-4a7bb9c659c1 - reference: Location/686d41ce-6486-5e13-b211-23417e86a8b9 healthcareService: - reference: HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368 search: mode: match summary: JSON Example description: |2 OrganizationAffiliationBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/OrganizationAffiliationSearchResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="c8a34f0b-f27f-49c3-a857-548de5d3d060"/> <meta> <lastUpdated value="2021-06-11T08:16:13.104Z"/> <profile value="http://hl7.org/fhir/StructureDefinition/Bundle"/> </meta> <type value="searchset"/> <total value="2"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation/aefac026-bbfc-5545-b6d6-21d30063ae02"/> <resource> <OrganizationAffiliation xmlns="http://hl7.org/fhir"> <id value="aefac026-bbfc-5545-b6d6-21d30063ae02"/> <meta> <lastUpdated value="2021-06-11T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation"/> </meta> <active value="true"/> <period> <start value="2013-01-01"/> </period> <organization> <reference value="Organization/d9110c8e-2f8a-5966-b52b-0e08aab0767c"/> <display value="University Physician Associates of New Jersey Inc"/> </organization> <participatingOrganization> <reference value="Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d"/> <display value="ARMEHTAMD PAINANDDISABILITYINSTITUTE PC"/> </participatingOrganization> <network> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </network> <code> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS"/> <code value="bt"/> </coding> </code> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="208100000X"/> </coding> </specialty> <location> <reference value="Location/a5454e38-857d-5f3e-b1a7-0b917b563762"/> </location> <location> <reference value="Location/686d41ce-6486-5e13-b211-23417e86a8b9"/> </location> <healthcareService> <reference value="HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368"/> </healthcareService> </OrganizationAffiliation> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation/9d9c8b8a-c490-5dd1-b550-f5b0d1b4fc3a"/> <resource> <OrganizationAffiliation xmlns="http://hl7.org/fhir"> <id value="9d9c8b8a-c490-5dd1-b550-f5b0d1b4fc3a"/> <meta> <lastUpdated value="2021-06-11T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation"/> </meta> <active value="true"/> <period> <start value="2018-03-21"/> </period> <organization> <reference value="Organization/09f01493-5f3a-5db0-afaf-e8b789371e7c"/> <display value="University Rehabilitation Associates"/> </organization> <participatingOrganization> <reference value="Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d"/> <display value="ARMEHTAMD PAINANDDISABILITYINSTITUTE PC"/> </participatingOrganization> <network> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </network> <code> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS"/> <code value="bt"/> </coding> </code> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="208100000X"/> </coding> </specialty> <location> <reference value="Location/e33dd5aa-613e-5731-ad69-4a7bb9c659c1"/> </location> <location> <reference value="Location/686d41ce-6486-5e13-b211-23417e86a8b9"/> </location> <healthcareService> <reference value="HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368"/> </healthcareService> </OrganizationAffiliation> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: |2 OrganizationAffiliationBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/OrganizationAffiliation/{id}: get: operationId: get_organization_affiliation description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/OrganizationAffiliationGetResponse' examples: JSONExample: value: resourceType: OrganizationAffiliation id: aefac026-bbfc-5545-b6d6-21d30063ae02 meta: lastUpdated: '2021-06-11T00:00:00.000+00:00' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation active: true period: start: '2013-01-01' organization: reference: Organization/d9110c8e-2f8a-5966-b52b-0e08aab0767c display: University Physician Associates of New Jersey Inc participatingOrganization: reference: Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d display: ARMEHTAMD PAINANDDISABILITYINSTITUTE PC network: - reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 code: - coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS code: bt specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 208100000X location: - reference: Location/a5454e38-857d-5f3e-b1a7-0b917b563762 - reference: Location/686d41ce-6486-5e13-b211-23417e86a8b9 healthcareService: - reference: HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368 summary: JSON Example description: |- OrganizationAffiliation Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/OrganizationAffiliationGetResponse' examples: XMLExample: value: | <?xml version='1.0' encoding='UTF-8'?> <OrganizationAffiliation xmlns="http://hl7.org/fhir"> <id value="aefac026-bbfc-5545-b6d6-21d30063ae02"/> <meta> <lastUpdated value="2021-06-11T00:00:00.000+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation"/> </meta> <active value="true"/> <period> <start value="2013-01-01"/> </period> <organization> <reference value="Organization/d9110c8e-2f8a-5966-b52b-0e08aab0767c"/> <display value="University Physician Associates of New Jersey Inc"/> </organization> <participatingOrganization> <reference value="Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d"/> <display value="ARMEHTAMD PAINANDDISABILITYINSTITUTE PC"/> </participatingOrganization> <network> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </network> <code> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS"/> <code value="bt"/> </coding> </code> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="208100000X"/> </coding> </specialty> <location> <reference value="Location/a5454e38-857d-5f3e-b1a7-0b917b563762"/> </location> <location> <reference value="Location/686d41ce-6486-5e13-b211-23417e86a8b9"/> </location> <healthcareService> <reference value="HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368"/> </healthcareService> </OrganizationAffiliation> summary: XML Example description: |- OrganizationAffiliation Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /providerdirectory/api/Practitioner: get: operationId: search_practitioner description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: _revinclude schema: enum: - PractitionerRole:practitioner type: string title: ' revinclude' minLength: 1 description: |- Include resources related to the search results Supported(PractitionerRole:practitioner) * `PractitionerRole:practitioner` - PractitionerRole:practitioner - in: query name: family schema: type: string minLength: 1 description: Practitioner's family name - in: query name: given schema: type: string minLength: 1 description: Practitioner's given name - in: query name: identifier schema: type: string minLength: 1 description: A practitioner's Identifier (NPI) - in: query name: name schema: type: string minLength: 1 description: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/PractitionerSearchResponse' examples: JSONExample: value: resourceType: Bundle id: 53d6ab1b-50fe-4140-8586-4e388e1890c2 meta: lastUpdated: '2021-06-14T16:31:35.904Z' type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/provider-directory/api/Practitioner entry: - fullUrl: https://public-api.cloverhealth.com/provider-directory/api/Practitioner/15d1c138-91e4-5c7e-bcde-b0cbafa0dffa resource: resourceType: Practitioner id: 15d1c138-91e4-5c7e-bcde-b0cbafa0dffa meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">Chantal M Brazeau</div> identifier: - system: http://hl7.org/fhir/sid/us-npi value: '1780796193' active: true name: - family: Brazeau given: - Chantal telecom: - extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary id: 8e6bd9c8-61db-5296-a270-c090a19e871b valueReference: reference: Location/8e6bd9c8-61db-5296-a270-c090a19e871b - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary id: f72c3f05-75c6-56da-8bec-3a9433f78b29 valueReference: reference: Location/f72c3f05-75c6-56da-8bec-3a9433f78b29 gender: male communication: - coding: - system: http://terminology.hl7.org/CodeSystem/iso639-3 code: eng text: eng search: mode: match - fullUrl: https://public-api.cloverhealth.com/provider-directory/api/Practitioner/47ba253a-33cb-5681-8406-0050edcaec83 resource: resourceType: Practitioner id: 47ba253a-33cb-5681-8406-0050edcaec83 meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">Ira M Brooks</div> identifier: - system: http://hl7.org/fhir/sid/us-npi value: '1437172111' active: true name: - family: Brooks given: - Ira telecom: - extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary id: 1cdaedef-a9cf-5166-83f3-3c5a03f2ef90 valueReference: reference: Location/1cdaedef-a9cf-5166-83f3-3c5a03f2ef90 gender: male communication: - coding: - system: http://terminology.hl7.org/CodeSystem/iso639-3 code: eng text: eng search: mode: match summary: JSON Example description: | PractitionerBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/PractitionerSearchResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="de2fbb9e-905e-4913-8de6-19e8fbb44850"/> <meta> <lastUpdated value="2022-12-12T02:03:33.887Z"/> </meta> <type value="searchset"/> <total value="2"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/provider-directory/api/Practitioner"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/provider-directory/api/Practitioner/15d1c138-91e4-5c7e-bcde-b0cbafa0dffa"/> <resource> <Practitioner> <id value="15d1c138-91e4-5c7e-bcde-b0cbafa0dffa"/> <meta> <lastUpdated value="2022-12-11T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Chantal M Brazeau</div> </text> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1780796193"/> </identifier> <active value="true"/> <name> <family value="Brazeau"/> <given value="Chantal"/> </name> <telecom> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary"> <valueReference> <reference value="Location/2f343c35-80bd-5be6-85e0-8a2d7c98128f"/> </valueReference> </extension> </telecom> <gender value="male"/> <communication> <coding> <system value="http://terminology.hl7.org/CodeSystem/iso639-3"/> <code value="eng"/> </coding> <text value="eng"/> </communication> </Practitioner> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/provider-directory/api/Practitioner/47ba253a-33cb-5681-8406-0050edcaec83"/> <resource> <Practitioner> <id value="47ba253a-33cb-5681-8406-0050edcaec83"/> <meta> <lastUpdated value="2022-12-11T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Ira M Brooks</div> </text> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1437172111"/> </identifier> <active value="true"/> <name> <family value="Brooks"/> <given value="Ira"/> </name> <telecom> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary"> <valueReference> <reference value="Location/3d794b48-d15b-5118-ae82-5a6d0b8a96bc"/> </valueReference> </extension> </telecom> <gender value="male"/> <communication> <coding> <system value="http://terminology.hl7.org/CodeSystem/iso639-3"/> <code value="eng"/> </coding> <text value="eng"/> </communication> </Practitioner> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: | PractitionerBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/Practitioner/{id}: get: operationId: get_practitioner description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/PractitionerGetResponse' examples: JSONExample: value: resourceType: Practitioner id: 47ba253a-33cb-5681-8406-0050edcaec83 meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">Ira M Brooks</div> identifier: - system: http://hl7.org/fhir/sid/us-npi value: '1437172111' active: true name: - family: Brooks given: - Ira telecom: - extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary id: 1cdaedef-a9cf-5166-83f3-3c5a03f2ef90 valueReference: reference: Location/1cdaedef-a9cf-5166-83f3-3c5a03f2ef90 gender: male communication: - coding: - system: http://terminology.hl7.org/CodeSystem/iso639-3 code: eng text: eng summary: JSON Example description: | Practitioner Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. application/fhir+xml: schema: $ref: '#/components/schemas/PractitionerGetResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='UTF-8'?> <Practitioner> <id value="15d1c138-91e4-5c7e-bcde-b0cbafa0dffa"/> <meta> <lastUpdated value="2022-12-11T00:00:00Z"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Chantal M Brazeau</div> </text> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1780796193"/> </identifier> <active value="true"/> <name> <family value="Brazeau"/> <given value="Chantal"/> </name> <telecom> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary"> <valueReference> <reference value="Location/2f343c35-80bd-5be6-85e0-8a2d7c98128f"/> </valueReference> </extension> </telecom> <gender value="male"/> <communication> <coding> <system value="http://terminology.hl7.org/CodeSystem/iso639-3"/> <code value="eng"/> </coding> <text value="eng"/> </communication> </Practitioner> summary: XML Example description: | Practitioner Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. description: '' /providerdirectory/api/PractitionerRole: get: operationId: search_practitioner_role description: This interaction searches a set of resources based on some filter criteria. summary: This interaction searches a set of resources based on some filter criteria. parameters: - in: query name: _count schema: type: integer maximum: 10000 minimum: 1 default: 20 title: ' count' description: Maximum number of results to be returned - in: query name: _id schema: type: string title: ' id' minLength: 1 description: Resource id (not a full URL) - in: query name: _include schema: enum: - PractitionerRole:practitioner - PractitionerRole:organization - PractitionerRole:location - PractitionerRole:service - PractitionerRole:network - PractitionerRole:endpoint type: string title: ' include' minLength: 1 description: |- Include resources related to the search results (Supported: PractitionerRole:practitioner, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:service, PractitionerRole:network, PractitionerRole:endpoint) * `PractitionerRole:practitioner` - PractitionerRole:practitioner * `PractitionerRole:organization` - PractitionerRole:organization * `PractitionerRole:location` - PractitionerRole:location * `PractitionerRole:service` - PractitionerRole:service * `PractitionerRole:network` - PractitionerRole:network * `PractitionerRole:endpoint` - PractitionerRole:endpoint - in: query name: _offset schema: type: integer minimum: 0 default: 0 title: ' offset' description: Number of results to be offset - in: query name: location schema: type: string minLength: 1 description: Location that the practitioner provider services at. - in: query name: network schema: type: string minLength: 1 description: Network that the practitioner is a part of. - in: query name: organization schema: type: string minLength: 1 description: The identity of the organization the practitioner represents / acts on behalf of - in: query name: practitioner schema: type: string minLength: 1 description: Practitioner that is able to provide the defined services for the organization - in: query name: role schema: type: string minLength: 1 description: The practitioner can perform this role at for the organization - in: query name: service schema: type: string minLength: 1 description: Service that the practitioner provides. - in: query name: specialty schema: type: string minLength: 1 description: The practitioner has this specialty at an organization tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/PractitionerRoleSearchResponse' examples: JSONExample: value: resourceType: Bundle id: be7670b9-3105-4874-8e84-a592f22ca05c meta: lastUpdated: '2021-06-14T16:30:36.366Z' type: searchset total: 2 link: - relation: self url: https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole entry: - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole/bfcec0d0-a895-5aea-91f3-1948598b9bdd resource: resourceType: PractitionerRole id: bfcec0d0-a895-5aea-91f3-1948598b9bdd meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">Scott Sundick</div> identifier: - system: http://hl7.org/fhir/sid/us-npi value: '1649449687' active: true extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients extension: - url: acceptingPatients valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS code: newpt - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference valueReference: reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 practitioner: reference: Practitioner/367921f5-2436-5897-96bb-09611da4c51e display: Scott Sundick organization: reference: Organization/3d0a9886-5edc-5c2b-9976-9a88712509bb display: Cardiovascular Care Group PC location: - reference: Location/3767a8b8-4a84-56f7-89b6-2af63a737a7c healthcareService: - reference: HealthcareService/86f22c44-882b-5ae6-a21d-3f58d89a6813 code: - coding: - system: http://terminology.hl7.org/CodeSystem/practitioner-role code: doctor specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 2086S0129X search: mode: match - fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole/43bc140f-395b-505c-96d5-37f0b5bcf52f resource: resourceType: PractitionerRole id: 43bc140f-395b-505c-96d5-37f0b5bcf52f meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">Scott Sundick</div> identifier: - system: http://hl7.org/fhir/sid/us-npi value: '1649449687' active: true extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients extension: - url: acceptingPatients valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS code: newpt - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference valueReference: reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 practitioner: reference: Practitioner/367921f5-2436-5897-96bb-09611da4c51e display: Scott Sundick organization: reference: Organization/3d0a9886-5edc-5c2b-9976-9a88712509bb display: Cardiovascular Care Group PC location: - reference: Location/2d7062f2-eb7e-516e-91e5-fd107b1fe104 healthcareService: - reference: HealthcareService/d83e1d95-3a94-5fa0-9f27-affe8dda4aea code: - coding: - system: http://terminology.hl7.org/CodeSystem/practitioner-role code: doctor specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 2086S0129X search: mode: match summary: JSON Example description: | PractitionerRoleBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/PractitionerRoleSearchResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='utf-8'?> <Bundle xmlns="http://hl7.org/fhir"> <id value="c1684b04-483f-4592-aacf-ddce9b087c64"/> <meta> <lastUpdated value="2023-01-13T04:25:44.452483+00:00"/> </meta> <type value="searchset"/> <total value="2"/> <link> <relation value="self"/> <url value="https://public-api.cloverhealth.com/providerdirectory/PractitionerRole"/> </link> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/PractitionerRole/907963c2-d3ed-55f9-9d99-255415379057"/> <resource> <PractitionerRole> <id value="907963c2-d3ed-55f9-9d99-255415379057"/> <meta> <lastUpdated value="2023-01-08T00:00:00+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Jillian K Rumbaugh</div> </text> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients"> <extension url="acceptingPatients"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS"/> <code value="newpt"/> </coding> </valueCodeableConcept> </extension> </extension> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference"> <valueReference> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </valueReference> </extension> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1669922357"/> </identifier> <active value="true"/> <practitioner> <reference value="Practitioner/34e14d8e-663b-5223-9929-89cd0cbd4ce7"/> <display value="Jillian K Rumbaugh"/> </practitioner> <code> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/ProviderRoleCS"/> <code value="pt"/> </coding> </code> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="225100000X"/> </coding> </specialty> <location> <reference value="Location/ef52e07e-4e52-5f4d-9cf7-a9f965d02367"/> </location> <healthcareService> <reference value="HealthcareService/f7416314-6f48-5b49-8a98-a7cd36af323a"/> </healthcareService> </PractitionerRole> </resource> <search> <mode value="match"/> </search> </entry> <entry> <fullUrl value="https://public-api.cloverhealth.com/providerdirectory/PractitionerRole/1ae01696-b558-51e7-9ffb-af79d25fcbcc"/> <resource> <PractitionerRole> <id value="1ae01696-b558-51e7-9ffb-af79d25fcbcc"/> <meta> <lastUpdated value="2023-01-08T00:00:00+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> STUTI NAIK</div> </text> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients"> <extension url="acceptingPatients"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS"/> <code value="newpt"/> </coding> </valueCodeableConcept> </extension> </extension> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference"> <valueReference> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </valueReference> </extension> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1609817469"/> </identifier> <active value="true"/> <practitioner> <reference value="Practitioner/ef99c960-aa5d-560b-a1d5-cf5b7f722a5f"/> <display value="STUTI NAIK"/> </practitioner> <code> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/ProviderRoleCS"/> <code value="pa"/> </coding> </code> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="363A00000X"/> </coding> </specialty> <location> <reference value="Location/d942e76f-ade0-5bb7-83cf-bbe4f7a6b995"/> </location> <healthcareService> <reference value="HealthcareService/873553b4-727b-5672-9222-3ccc70c90a5b"/> </healthcareService> </PractitionerRole> </resource> <search> <mode value="match"/> </search> </entry> </Bundle> summary: XML Example description: | PractitionerRoleBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' /providerdirectory/api/PractitionerRole/{id}: get: operationId: get_practitioner_role description: The read interaction accesses the current contents of a resource. summary: The read interaction accesses the current contents of a resource. parameters: - in: path name: id schema: type: string required: true tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/PractitionerRoleItemResponse' examples: JSONExample: value: resourceType: PractitionerRole id: bfcec0d0-a895-5aea-91f3-1948598b9bdd meta: lastUpdated: '2021-06-14T00:00:00Z' profile: - http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole text: status: generated div: <div xmlns="http://www.w3.org/1999/xhtml">Scott Sundick</div> identifier: - system: http://hl7.org/fhir/sid/us-npi value: '1649449687' active: true extension: - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients extension: - url: acceptingPatients valueCodeableConcept: coding: - system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS code: newpt - url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference valueReference: reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056 practitioner: reference: Practitioner/367921f5-2436-5897-96bb-09611da4c51e display: Scott Sundick organization: reference: Organization/3d0a9886-5edc-5c2b-9976-9a88712509bb display: Cardiovascular Care Group PC location: - reference: Location/3767a8b8-4a84-56f7-89b6-2af63a737a7c healthcareService: - reference: HealthcareService/86f22c44-882b-5ae6-a21d-3f58d89a6813 code: - coding: - system: http://terminology.hl7.org/CodeSystem/practitioner-role code: doctor specialty: - coding: - system: http://nucc.org/provider-taxonomy code: 2086S0129X summary: JSON Example description: | PractitionerRole Roles/organizations the practitioner is associated with Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension application/fhir+xml: schema: $ref: '#/components/schemas/PractitionerRoleItemResponse' examples: XMLExample: value: |- <?xml version='1.0' encoding='utf-8'?> <PractitionerRole xmlns="http://hl7.org/fhir"> <id value="907963c2-d3ed-55f9-9d99-255415379057"/> <meta> <lastUpdated value="2023-01-08T00:00:00+00:00"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">Jillian K Rumbaugh</div> </text> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients"> <extension url="acceptingPatients"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS"/> <code value="newpt"/> </coding> </valueCodeableConcept> </extension> </extension> <extension url="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference"> <valueReference> <reference value="Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056"/> </valueReference> </extension> <identifier> <system value="http://hl7.org/fhir/sid/us-npi"/> <value value="1669922357"/> </identifier> <active value="true"/> <practitioner> <reference value="Practitioner/34e14d8e-663b-5223-9929-89cd0cbd4ce7"/> <display value="Jillian K Rumbaugh"/> </practitioner> <code> <coding> <system value="http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/ProviderRoleCS"/> <code value="pt"/> </coding> </code> <specialty> <coding> <system value="http://nucc.org/provider-taxonomy"/> <code value="225100000X"/> </coding> </specialty> <location> <reference value="Location/ef52e07e-4e52-5f4d-9cf7-a9f965d02367"/> </location> <healthcareService> <reference value="HealthcareService/f7416314-6f48-5b49-8a98-a7cd36af323a"/> </healthcareService> </PractitionerRole> summary: XML Example description: | PractitionerRole Roles/organizations the practitioner is associated with Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension description: '' /providerdirectory/api/metadata: get: operationId: get_metadata description: This interaction searches a set of resources based on some filter criteria.. summary: This interaction searches a set of resources based on some filter criteria.. tags: - FHIR R4 ProviderDirectory API security: - cookieAuth: [] - basicAuth: [] - {} responses: '200': content: application/fhir+json: schema: $ref: '#/components/schemas/FHIRCapabilityStatement' examples: JSONExample: value: resourceType: CapabilityStatement id: '1933611' meta: versionId: '1' lastUpdated: '2021-03-08T19:27:59.034+00:00' source: '#jURcAPyvWNKEoveb' status: active date: '2021-03-08T16:17:22-03:00' publisher: Clover Health kind: instance software: name: Clover Health FHIR R4 Provider Directory API version: 4.2.0 implementation: description: DaVinci PDEX Plan Net url: https://build.fhir.org/ig/HL7/davinci-pdex-plan-net/ fhirVersion: 4.0.1 format: - application/fhir+xml - application/fhir+json rest: - mode: server resource: - type: Bundle profile: http://hl7.org/fhir/StructureDefinition/Bundle interaction: - code: read - type: HealthcareService profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService interaction: - code: read - code: search-type searchRevInclude: - PractitionerRole:practitioner searchInclude: - HealthcareService:location - HealthcareService:coverage-area - HealthcareService:organization - HealthcareService:endpoint searchParam: - name: identifier type: token documentation: A healthcare service's Identifier (NPI) - name: location type: reference documentation: The location of a healthcare service - name: coverage-area type: reference documentation: The coverage-area of a healthcare service - name: organization type: reference documentation: The organization that the healthcare service belongs to - name: service-category type: string documentation: The category of a healthcare service - name: service-type type: string documentation: The type of a healthcare service - name: name type: string documentation: The name of a healthcare service - name: specialty type: string documentation: The specialty of a healthcare service - type: Practitioner profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner interaction: - code: read - code: search-type searchRevInclude: - PractitionerRole:practitioner searchParam: - name: identifier type: token documentation: A practitioner's Identifier (NPI) - name: name type: string documentation: A practitioner's name - name: family type: string documentation: A practitioner's family name - name: given type: string documentation: A practitioner's given name - type: PractitionerRole profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole interaction: - code: read - code: search-type searchInclude: - PractitionerRole:organization - PractitionerRole:practitioner - PractitionerRole:location - PractitionerRole:service - PractitionerRole:network searchParam: - name: organization type: reference documentation: The identity of the organization the practitioner represents / acts on behalf of - name: practitioner type: reference documentation: Practitioner that is able to provide the defined services for the organization - name: network type: reference documentation: The network work that the practitioner is in. - name: location type: reference documentation: The location that the practitioner provide service at. - name: service type: reference documentation: The healthcare service the practitioner provides. - name: specialty type: string documentation: The specialties of practitioner - name: role type: string documentation: The credential type of a practitioner - type: Location profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location interaction: - code: read - code: search-type searchRevInclude: - HealthcareService:location - InsurancePlan:coverage-area - OrganizationAffiliation:location - PractitionerRole:location searchInclude: - Location:organization - Location:partof searchParam: - name: name type: string documentation: The name of the location - name: near type: special documentation: Geo information (longitude, latitude) of the location - name: identifier type: token documentation: NPI of the location - name: partOf type: reference documentation: The location that a location is physically part of. - name: organization type: reference documentation: The organization that a location belongs to. - name: type type: string documentation: The type of a location - name: address type: string documentation: Address of the location - name: address-city type: string documentation: City of the location - name: address-state type: string documentation: State of the location - name: address-postalCode type: string documentation: Postal code of the location - type: Endpoint profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint interaction: - code: read - code: search-type - type: Organization profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization interaction: - code: read - code: search-type - type: OrganizationAffiliation profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation interaction: - code: read - code: search-type summary: JSON Example description: | CapabilityStatementBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language application/fhir+xml: schema: $ref: '#/components/schemas/FHIRCapabilityStatement' examples: XMLExample: value: resourceType: CapabilityStatement id: '1933611' meta: versionId: '1' lastUpdated: '2021-03-08T19:27:59.034+00:00' source: '#jURcAPyvWNKEoveb' status: active date: '2021-03-08T16:17:22-03:00' publisher: Clover Health kind: instance software: name: Clover Health FHIR R4 Provider Directory API version: 4.2.0 implementation: description: DaVinci PDEX Plan Net url: https://build.fhir.org/ig/HL7/davinci-pdex-plan-net/ fhirVersion: 4.0.1 format: - application/fhir+xml - application/fhir+json rest: - mode: server resource: - type: Bundle profile: http://hl7.org/fhir/StructureDefinition/Bundle interaction: - code: read - type: HealthcareService profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService interaction: - code: read - code: search-type searchRevInclude: - PractitionerRole:practitioner searchInclude: - HealthcareService:location - HealthcareService:coverage-area - HealthcareService:organization - HealthcareService:endpoint searchParam: - name: identifier type: token documentation: A healthcare service's Identifier (NPI) - name: location type: reference documentation: The location of a healthcare service - name: coverage-area type: reference documentation: The coverage-area of a healthcare service - name: organization type: reference documentation: The organization that the healthcare service belongs to - name: service-category type: string documentation: The category of a healthcare service - name: service-type type: string documentation: The type of a healthcare service - name: name type: string documentation: The name of a healthcare service - name: specialty type: string documentation: The specialty of a healthcare service - type: Practitioner profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner interaction: - code: read - code: search-type searchRevInclude: - PractitionerRole:practitioner searchParam: - name: identifier type: token documentation: A practitioner's Identifier (NPI) - name: name type: string documentation: A practitioner's name - name: family type: string documentation: A practitioner's family name - name: given type: string documentation: A practitioner's given name - type: PractitionerRole profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole interaction: - code: read - code: search-type searchInclude: - PractitionerRole:organization - PractitionerRole:practitioner - PractitionerRole:location - PractitionerRole:service - PractitionerRole:network searchParam: - name: organization type: reference documentation: The identity of the organization the practitioner represents / acts on behalf of - name: practitioner type: reference documentation: Practitioner that is able to provide the defined services for the organization - name: network type: reference documentation: The network work that the practitioner is in. - name: location type: reference documentation: The location that the practitioner provide service at. - name: service type: reference documentation: The healthcare service the practitioner provides. - name: specialty type: string documentation: The specialties of practitioner - name: role type: string documentation: The credential type of a practitioner - type: Location profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location interaction: - code: read - code: search-type searchRevInclude: - HealthcareService:location - InsurancePlan:coverage-area - OrganizationAffiliation:location - PractitionerRole:location searchInclude: - Location:organization - Location:partof searchParam: - name: name type: string documentation: The name of the location - name: near type: special documentation: Geo information (longitude, latitude) of the location - name: identifier type: token documentation: NPI of the location - name: partOf type: reference documentation: The location that a location is physically part of. - name: organization type: reference documentation: The organization that a location belongs to. - name: type type: string documentation: The type of a location - name: address type: string documentation: Address of the location - name: address-city type: string documentation: City of the location - name: address-state type: string documentation: State of the location - name: address-postalCode type: string documentation: Postal code of the location - type: Endpoint profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint interaction: - code: read - code: search-type - type: Organization profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization interaction: - code: read - code: search-type - type: OrganizationAffiliation profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation interaction: - code: read - code: search-type summary: XML Example description: | CapabilityStatementBundle Contains a collection of resources - Rule: total only when a search or history - Rule: entry.search only when a search - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) - Rule: A document must have an identifier with a system and a value - Rule: A document must have a date - Rule: A document must have a Composition as the first resource - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language description: '' components: schemas: BaseBundleLink: type: object properties: relation: type: string url: type: string description: Reference details for the link required: - relation - url BaseBundleMeta: type: object properties: lastUpdated: type: string format: date-time required: - lastUpdated BaseBundleSearch: type: object properties: mode: $ref: '#/components/schemas/SearchModeEnum' required: - mode BaseBundleSignature: type: object properties: when: type: string format: date-time description: When the signature was created who: type: string description: Who signed targetFormat: type: string description: The technical format of the signed resources sigFormat: type: string description: The technical format of the signature onBehalfOf: type: string description: The party represented type: type: array items: {} description: Indication of the reason the entity signed the object(s) data: type: string description: The actual signature content (XML DigSig. JWT, picture, etc.) required: - data - type - when BaseResourceMeta: type: object properties: lastUpdated: type: string format: date-time description: When the resource version last changed profile: type: array items: {} description: Profiles this resource claims to conform to versionId: type: string description: Version specific identifier source: type: string description: Identifies where the resource comes from required: - profile BaseResourceText: type: object properties: status: type: string div: type: string required: - div - status CodeEnum: enum: - read - vread - update - patch - delete - history-instance - history-type - create - search-type type: string description: |- * `read` - read * `vread` - vread * `update` - update * `patch` - patch * `delete` - delete * `history-instance` - history-instance * `history-type` - history-type * `create` - create * `search-type` - search-type CommonReference: type: object properties: reference: type: string required: - reference EndpointGetResponse: type: object properties: resourceType: type: string id: type: string meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource text: allOf: - $ref: '#/components/schemas/BaseResourceText' description: Text summary of the resource, for human interpretation status: $ref: '#/components/schemas/EndpointGetResponseStatusEnum' connectionType: allOf: - $ref: '#/components/schemas/FHIRCodeableConcept' description: Protocol/Profile/Standard to be used with this endpoint connection managingOrganization: allOf: - $ref: '#/components/schemas/CommonReference' description: Organization that manages this endpoint payloadType: allOf: - $ref: '#/components/schemas/FHIRCodeableConcept' description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) address: type: string description: The technical base address for connecting to this endpoint required: - address - id - meta - resourceType - status - text EndpointGetResponseStatusEnum: enum: - active - suspended - error - 'off' - entered-in-error - test type: string description: |- * `active` - active * `suspended` - suspended * `error` - error * `off` - off * `entered-in-error` - entered-in-error * `test` - test EndpointSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/EndpointGetResponse' description: A resource in the bundle required: - fullUrl - resource - search EndpointSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/EndpointSearchEntry' required: - entry - id - link - meta - resourceType - total - type FHIRAddress: type: object properties: use: allOf: - $ref: '#/components/schemas/FHIRAddressUseEnum' description: |- purpose of this address * `home` - home * `work` - work * `temp` - temp * `old` - old * `billing` - billing type: $ref: '#/components/schemas/FHIRAddressTypeEnum' text: type: string description: Text representation of the address line: type: string description: 'Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label' city: type: string description: Name of city, town etc. district: type: string description: District name (aka county) state: type: string description: Sub-unit of country (abbreviations ok) postalCode: type: string description: Postal code for area country: type: string description: Country (e.g. may be ISO 3166 2 or 3 letter code) period: allOf: - $ref: '#/components/schemas/FHIRPeriod' description: Time period when address was/is in use FHIRAddressTypeEnum: enum: - postal - physical - both type: string description: |- * `postal` - postal * `physical` - physical * `both` - both FHIRAddressUseEnum: enum: - home - work - temp - old - billing type: string description: |- * `home` - home * `work` - work * `temp` - temp * `old` - old * `billing` - billing FHIRCapabilityStatement: type: object properties: resourceType: type: string default: CapabilityStatement id: type: string meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about a resource status: $ref: '#/components/schemas/PublicationStatusEnum' date: type: string format: date-time description: Date last changed publisher: type: string description: Name of the publisher/steward kind: $ref: '#/components/schemas/KindEnum' software: allOf: - $ref: '#/components/schemas/FHIRCapabilityStatementSoftware' description: Software that is covered by this capability statement fhirVersion: type: string description: FHIR Version the system supports format: type: array items: type: string description: formats supported (xml | json | ttl | mime type) rest: type: array items: $ref: '#/components/schemas/FHIRCapabilityStatementRest' description: "\tIf the endpoint is a RESTful one" required: - date - fhirVersion - format - kind - meta - status FHIRCapabilityStatementInteractionCode: type: object properties: code: $ref: '#/components/schemas/CodeEnum' required: - code FHIRCapabilityStatementRest: type: object properties: mode: $ref: '#/components/schemas/FHIRCapabilityStatementRestModeEnum' resource: type: array items: $ref: '#/components/schemas/FHIRCapabilityStatementRestResource' description: Resource served on the REST interface required: - mode - resource FHIRCapabilityStatementRestModeEnum: enum: - client - server type: string description: |- * `client` - client * `server` - server FHIRCapabilityStatementRestResource: type: object properties: type: type: string description: A resource type that is supported profile: type: string description: System-wide profile interaction: type: array items: $ref: '#/components/schemas/FHIRCapabilityStatementInteractionCode' searchInclude: type: array items: type: string description: _include values supported by the server searchRevInclude: type: array items: type: string description: _revinclude values supported by the server required: - searchInclude - searchRevInclude - type FHIRCapabilityStatementSoftware: type: object properties: name: type: string description: A name the software is known by version: type: string description: Version covered by this statement releaseDate: type: string format: date-time description: Date this version was released FHIRCodeableConcept: type: object properties: coding: type: array items: $ref: '#/components/schemas/FHIRCoding' description: Code defined by a terminology system text: type: string FHIRCoding: type: object properties: system: type: string description: Identity of the terminology system version: type: string description: Version of the system - if relevant code: type: string description: Symbol in syntax defined by the system display: type: string description: Representation defined by the system userSelected: type: string description: If this coding was chosen directly by the user FHIRContactPoint: type: object properties: system: $ref: '#/components/schemas/SystemEnum' value: type: string description: The actual contact point details use: allOf: - $ref: '#/components/schemas/FHIRContactPointUseEnum' description: |- purpose of this contact point * `home` - home * `work` - work * `temp` - temp * `old` - old * `mobile` - mobile rank: type: integer description: Specify preferred order of use (1 = highest) period: allOf: - $ref: '#/components/schemas/FHIRPeriod' description: Time period when the contact point was/is in use FHIRContactPointUseEnum: enum: - home - work - temp - old - mobile type: string description: |- * `home` - home * `work` - work * `temp` - temp * `old` - old * `mobile` - mobile FHIRExtendedContactDetail: type: object properties: purpose: $ref: '#/components/schemas/FHIRCodeableConcept' name: type: array items: $ref: '#/components/schemas/FHIRHumanName' telecom: type: array items: $ref: '#/components/schemas/FHIRContactPoint' address: $ref: '#/components/schemas/FHIRAddress' organization: $ref: '#/components/schemas/CommonReference' period: $ref: '#/components/schemas/FHIRPeriod' FHIRHumanName: type: object properties: use: $ref: '#/components/schemas/FHIRHumanNameUseEnum' text: type: string description: Text representation of the full name family: type: string description: Family name (often called 'Surname') given: type: array items: type: string description: |- Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name prefix: type: array items: type: string description: |- Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name suffix: type: array items: type: string description: |- Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name period: allOf: - $ref: '#/components/schemas/FHIRPeriod' description: Time period when name was/is in use FHIRHumanNameUseEnum: enum: - usual - official - temp - nickname - anonymous - old - maiden type: string description: |- * `usual` - usual * `official` - official * `temp` - temp * `nickname` - nickname * `anonymous` - anonymous * `old` - old * `maiden` - maiden FHIRIdentifier: type: object properties: use: $ref: '#/components/schemas/FHIRIdentifierUseEnum' type: allOf: - $ref: '#/components/schemas/FHIRCodeableConcept' description: Description of identifier system: type: string description: The namespace for the identifier value value: type: string description: The value that is unique period: allOf: - $ref: '#/components/schemas/FHIRPeriod' description: Time period when id is/was valid for use assigner: type: string description: Organization that issued id (may be just text) FHIRIdentifierUseEnum: enum: - usual - official - temp - secondary - old type: string description: |- * `usual` - usual * `official` - official * `temp` - temp * `secondary` - secondary * `old` - old FHIRPeriod: type: object properties: start: type: string format: date-time description: Starting time with inclusive boundary end: type: string format: date-time description: End time with inclusive boundary, if not ongoing FormularyListEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/FormularyListEntrySearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/FormularyListItemResponse' description: A resource in the bundle required: - fullUrl - resource - search FormularyListEntrySearch: type: object properties: mode: $ref: '#/components/schemas/SearchModeEnum' required: - mode FormularyListItemEntry: type: object properties: item: $ref: '#/components/schemas/FormularyListItemEntryItem' required: - item FormularyListItemEntryItem: type: object properties: reference: type: string required: - reference FormularyListItemExtension: type: object properties: url: type: string extension: type: array items: $ref: '#/components/schemas/FormularyListItemExtensionValue' required: - extension - url FormularyListItemExtensionExtensionValueBoolean: type: object properties: url: type: string valueBoolean: type: boolean required: - url - valueBoolean FormularyListItemExtensionExtensionValueCodeableConcept: type: object properties: url: type: string valueCodeableConcept: $ref: '#/components/schemas/FormularyListItemExtensionExtensionvalueCodeableConcept' required: - url - valueCodeableConcept FormularyListItemExtensionExtensionValueString: type: object properties: url: type: string valueString: type: string required: - url - valueString FormularyListItemExtensionExtensionvalueCodeableConcept: type: object properties: coding: type: array items: $ref: '#/components/schemas/FormularyListItemExtensionExtensionvalueCodeableConceptCoding' required: - coding FormularyListItemExtensionExtensionvalueCodeableConceptCoding: type: object properties: system: type: string code: type: string display: type: string required: - code - display - system FormularyListItemExtensionValue: oneOf: - $ref: '#/components/schemas/FormularyListItemExtensionExtensionValueCodeableConcept' - $ref: '#/components/schemas/FormularyListItemExtensionExtensionValueBoolean' - $ref: '#/components/schemas/FormularyListItemExtensionExtensionValueString' discriminator: propertyName: type mapping: valueCodeableConcept: '#/components/schemas/FormularyListItemExtensionExtensionValueCodeableConcept' valueBoolean: '#/components/schemas/FormularyListItemExtensionExtensionValueBoolean' valueString: '#/components/schemas/FormularyListItemExtensionExtensionValueString' FormularyListItemIdentifier: type: object properties: system: type: string value: type: string required: - value FormularyListItemMeta: type: object properties: lastUpdated: type: string format: date-time profile: type: array items: {} required: - lastUpdated - profile FormularyListItemResponse: type: object properties: resourceType: type: string id: type: string meta: $ref: '#/components/schemas/FormularyListItemMeta' identifier: type: array items: $ref: '#/components/schemas/FormularyListItemIdentifier' status: $ref: '#/components/schemas/FormularyListItemResponseStatusEnum' mode: $ref: '#/components/schemas/ResponseModeEnum' title: type: string date: type: string format: date-time extension: $ref: '#/components/schemas/FormularyListItemExtension' entry: type: array items: $ref: '#/components/schemas/FormularyListItemEntry' required: - date - entry - extension - id - identifier - meta - mode - resourceType - status - title FormularyListItemResponseStatusEnum: enum: - current - retired - entered-in-error type: string description: |- * `current` - current * `retired` - retired * `entered-in-error` - entered-in-error FormularyListResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/FormularyListEntry' description: |- Entry in the bundle - will have a resource or information Rule: must be a resource unless there's a request or response Rule: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type required: - entry - id - link - meta - resourceType - total - type FormularyMedicationKnowledgeEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/FormularyMedicationKnowledgeEntrySearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/FormularyMedicationKnowledgeItemResponse' description: A resource in the bundle required: - fullUrl - resource - search FormularyMedicationKnowledgeEntrySearch: type: object properties: mode: $ref: '#/components/schemas/SearchModeEnum' required: - mode FormularyMedicationKnowledgeItemExtensionValue: oneOf: - $ref: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionValueCodeableConcept' - $ref: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionValueBoolean' - $ref: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionValueString' discriminator: propertyName: type mapping: valueCodeableConcept: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionValueCodeableConcept' valueBoolean: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionValueBoolean' valueString: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionValueString' FormularyMedicationKnowledgeItemExtensionValueBoolean: type: object properties: url: type: string valueBoolean: type: boolean required: - url - valueBoolean FormularyMedicationKnowledgeItemExtensionValueCodeableConcept: type: object properties: url: type: string valueCodeableConcept: $ref: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionvalueCodeableConcept' required: - url - valueCodeableConcept FormularyMedicationKnowledgeItemExtensionValueString: type: object properties: url: type: string valueString: type: string required: - url - valueString FormularyMedicationKnowledgeItemExtensionvalueCodeableConcept: type: object properties: coding: type: array items: $ref: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionvalueCodeableConceptCoding' required: - coding FormularyMedicationKnowledgeItemExtensionvalueCodeableConceptCoding: type: object properties: system: type: string code: type: string display: type: string required: - code - display - system FormularyMedicationKnowledgeItemMeta: type: object properties: lastUpdated: type: string format: date-time profile: type: array items: {} required: - profile FormularyMedicationKnowledgeItemResponse: type: object properties: resourceType: type: string id: type: string meta: $ref: '#/components/schemas/FormularyMedicationKnowledgeItemMeta' text: allOf: - $ref: '#/components/schemas/FormularyMedicationKnowledgeItemText' description: Text summary of the resource, for human interpretation extension: type: array items: $ref: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionValue' code: $ref: '#/components/schemas/FormularyMedicationKnowledgeItemExtensionvalueCodeableConcept' required: - code - extension - id - meta - resourceType - text FormularyMedicationKnowledgeItemText: type: object properties: status: type: string div: type: string required: - div - status FormularyMedicationKnowledgeResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/FormularyMedicationKnowledgeEntry' required: - entry - id - link - meta - resourceType - total - type GenderEnum: enum: - male - female - other - unknown type: string description: |- * `male` - male * `female` - female * `other` - other * `unknown` - unknown HealthcareServiceGetExtension: type: object properties: extension: type: array items: $ref: '#/components/schemas/HealthcareServiceGetExtensionExtension' url: type: string required: - extension - url HealthcareServiceGetExtensionExtension: type: object properties: url: type: string valueCodeableConcept: $ref: '#/components/schemas/FHIRCodeableConcept' required: - url - valueCodeableConcept HealthcareServiceGetResponse: type: object properties: resourceType: type: string id: type: string meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource identifier: allOf: - $ref: '#/components/schemas/FHIRIdentifier' description: External identifiers for this item active: type: boolean description: Whether this HealthcareService record is in active use extension: $ref: '#/components/schemas/HealthcareServiceGetExtension' category: $ref: '#/components/schemas/FHIRCodeableConcept' type: $ref: '#/components/schemas/FHIRCodeableConcept' location: $ref: '#/components/schemas/CommonReference' coverageArea: $ref: '#/components/schemas/CommonReference' providedBy: $ref: '#/components/schemas/CommonReference' name: type: string telecom: type: array items: $ref: '#/components/schemas/HealthcareServiceGetTelecom' specialty: $ref: '#/components/schemas/FHIRCodeableConcept' required: - active - category - id - meta - name - resourceType - telecom - type HealthcareServiceGetTelecom: type: object properties: extension: type: array items: $ref: '#/components/schemas/HealthcareServiceGetTelecomExtension' required: - extension HealthcareServiceGetTelecomExtension: type: object properties: url: type: string valueReference: $ref: '#/components/schemas/CommonReference' required: - url - valueReference HealthcareServiceSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/HealthcareServiceGetResponse' description: A resource in the bundle required: - fullUrl - resource - search HealthcareServiceSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/HealthcareServiceSearchEntry' required: - entry - id - link - meta - resourceType - total - type InsurancePlanGetResponse: type: object properties: resourceType: type: string id: type: string meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource identifier: allOf: - $ref: '#/components/schemas/FHIRIdentifier' description: Business Identifier for Product status: $ref: '#/components/schemas/PublicationStatusEnum' type: type: array items: $ref: '#/components/schemas/FHIRCodeableConcept' description: Kind of product ownedBy: allOf: - $ref: '#/components/schemas/CommonReference' description: Product issuer administeredBy: allOf: - $ref: '#/components/schemas/CommonReference' description: Product administrator network: type: array items: $ref: '#/components/schemas/CommonReference' description: What networks are Included coverageArea: type: array items: $ref: '#/components/schemas/CommonReference' description: Where product applies name: type: string description: Official name required: - id - meta - resourceType - status InsurancePlanSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/InsurancePlanGetResponse' description: A resource in the bundle required: - fullUrl - resource - search InsurancePlanSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/InsurancePlanSearchEntry' required: - entry - id - link - meta - resourceType - total - type KindEnum: enum: - instance - capability - requirements type: string description: |- * `instance` - instance * `capability` - capability * `requirements` - requirements LocationGetPosition: type: object properties: longitude: type: string format: decimal pattern: ^-?0?(?:\.\d{0,18})?$ description: Longitude with WGS84 datum latitude: type: string format: decimal pattern: ^-?0?(?:\.\d{0,18})?$ description: Latitude with WGS84 datum required: - latitude - longitude LocationGetResponse: type: object properties: resourceType: type: string id: type: string meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource text: allOf: - $ref: '#/components/schemas/BaseResourceText' description: Text summary of the resource, for human interpretation status: $ref: '#/components/schemas/LocationGetResponseStatusEnum' name: type: string description: Name of the location as used by humans type: type: array items: $ref: '#/components/schemas/FHIRCodeableConcept' description: Type of function performed telecom: type: array items: $ref: '#/components/schemas/LocationGetTelecom' description: Official contact details for the location address: allOf: - $ref: '#/components/schemas/FHIRAddress' description: Physical location position: allOf: - $ref: '#/components/schemas/LocationGetPosition' description: The absolute geographic location managingOrganization: allOf: - $ref: '#/components/schemas/CommonReference' description: Organization responsible for provisioning and upkeep partOf: allOf: - $ref: '#/components/schemas/CommonReference' description: Another Location this one is physically a part of endpoint: allOf: - $ref: '#/components/schemas/CommonReference' description: Technical endpoints providing access to services operated for the location required: - id - meta - name - resourceType - status - text LocationGetResponseStatusEnum: enum: - active - suspended - inactive type: string description: |- * `active` - active * `suspended` - suspended * `inactive` - inactive LocationGetTelecom: type: object properties: phone: $ref: '#/components/schemas/FHIRContactPoint' fax: $ref: '#/components/schemas/FHIRContactPoint' LocationSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/LocationGetResponse' description: A resource in the bundle required: - fullUrl - resource - search LocationSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/LocationSearchEntry' required: - entry - id - link - meta - resourceType - total - type OrganizationAffiliationGetOrganization: type: object properties: reference: type: string display: type: string required: - display - reference OrganizationAffiliationGetPeriod: type: object properties: start: type: string format: date description: Starting time with inclusive boundary end: type: string format: date description: End time with inclusive boundary, if not ongoing OrganizationAffiliationGetReference: type: object properties: reference: type: string required: - reference OrganizationAffiliationGetResponse: type: object properties: resourceType: type: string id: type: string description: Business identifiers that are specific to this role meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource active: type: boolean description: Whether this organization affiliation record is in active use period: allOf: - $ref: '#/components/schemas/OrganizationAffiliationGetPeriod' description: The period during which the participatingOrganization is affiliated with the primary organization organization: allOf: - $ref: '#/components/schemas/OrganizationAffiliationGetOrganization' description: Organization where the role is available participatingOrganization: allOf: - $ref: '#/components/schemas/OrganizationAffiliationGetOrganization' description: Organization that provides/performs the role (e.g. providing services or is a member of) network: type: array items: $ref: '#/components/schemas/OrganizationAffiliationGetReference' description: The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) code: type: array items: $ref: '#/components/schemas/FHIRCodeableConcept' description: Definition of the role the participatingOrganization plays specialty: type: array items: $ref: '#/components/schemas/FHIRCodeableConcept' description: Specific specialty of the participatingOrganization in the context of the role location: type: array items: $ref: '#/components/schemas/OrganizationAffiliationGetReference' description: The location(s) at which the role occurs healthcareService: type: array items: $ref: '#/components/schemas/OrganizationAffiliationGetReference' description: Healthcare services provided through the role required: - active - code - healthcareService - id - location - meta - network - organization - participatingOrganization - resourceType - specialty OrganizationAffiliationSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/OrganizationAffiliationGetResponse' description: A resource in the bundle required: - fullUrl - resource - search OrganizationAffiliationSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/OrganizationAffiliationSearchEntry' required: - entry - id - link - meta - resourceType - total - type OrganizationGetResponse: type: object properties: resourceType: type: string id: type: string meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource text: allOf: - $ref: '#/components/schemas/BaseResourceText' description: Text summary of the resource, for human interpretation identifier: type: array items: $ref: '#/components/schemas/FHIRIdentifier' description: Identifies this organization across multiple systems active: type: boolean description: Whether the organization's record is still in active use type: allOf: - $ref: '#/components/schemas/FHIRCodeableConcept' description: Kind of organization name: type: string description: Name used for the organization telecom: allOf: - $ref: '#/components/schemas/OrganizationGetTelecom' description: Contact details (e.g.phone/fax/url) address: allOf: - $ref: '#/components/schemas/FHIRAddress' description: Address for the contact partOf: allOf: - $ref: '#/components/schemas/CommonReference' description: The organization of which this organization forms a part contact: allOf: - $ref: '#/components/schemas/FHIRExtendedContactDetail' description: Official contact details for the Organization endpoint: allOf: - $ref: '#/components/schemas/CommonReference' description: Technical endpoints providing access to services operated for the organization required: - active - id - identifier - meta - name - resourceType - text OrganizationGetTelecom: type: object properties: phone: $ref: '#/components/schemas/FHIRContactPoint' fax: $ref: '#/components/schemas/FHIRContactPoint' OrganizationSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/OrganizationGetResponse' description: A resource in the bundle required: - fullUrl - resource - search OrganizationSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/OrganizationSearchEntry' required: - entry - id - link - meta - resourceType - total - type PractitionerGetResponse: type: object properties: resourceType: type: string id: type: string meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource text: allOf: - $ref: '#/components/schemas/BaseResourceText' description: Text summary of the resource, for human interpretation identifier: type: array items: $ref: '#/components/schemas/FHIRIdentifier' description: An identifier for the person as this agent active: type: boolean description: Whether this practitioner's record is in active use name: allOf: - $ref: '#/components/schemas/FHIRHumanName' description: The name(s) associated with the practitioner telecom: type: array items: $ref: '#/components/schemas/PractitionerGetTelecom' description: A contact detail for the practitioner (that apply to all roles) gender: $ref: '#/components/schemas/GenderEnum' communication: type: array items: $ref: '#/components/schemas/FHIRCodeableConcept' required: - active - communication - gender - id - identifier - meta - name - resourceType - telecom - text PractitionerGetTelecom: type: object properties: extension: type: array items: $ref: '#/components/schemas/PractitionerGetTelecomExtension' required: - extension PractitionerGetTelecomExtension: type: object properties: url: type: string id: type: string valueReference: $ref: '#/components/schemas/CommonReference' required: - id - url - valueReference PractitionerRoleItemCode: type: object properties: coding: type: array items: $ref: '#/components/schemas/PractitionerRoleItemCoding' required: - coding PractitionerRoleItemCoding: type: object properties: system: type: string code: type: string required: - code - system PractitionerRoleItemEndpoint: type: object properties: reference: type: string required: - reference PractitionerRoleItemExtensionValue: oneOf: - $ref: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConcept' - $ref: '#/components/schemas/PractitionerRoleItemExtensionValueReference' discriminator: propertyName: type mapping: valueCodeableConcept: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConcept' valueReference: '#/components/schemas/PractitionerRoleItemExtensionValueReference' PractitionerRoleItemExtensionValueCodeableConcept: type: object properties: url: type: string valueCodeableConcept: $ref: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConceptCoding' required: - url - valueCodeableConcept PractitionerRoleItemExtensionValueCodeableConceptCoding: type: object properties: coding: type: array items: $ref: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConceptCodingCodingContent' required: - coding PractitionerRoleItemExtensionValueCodeableConceptCodingCodingContent: type: object properties: system: type: string code: type: string required: - code - system PractitionerRoleItemExtensionValueReference: type: object properties: url: type: string valueReference: $ref: '#/components/schemas/PractitionerRoleItemExtensionValueReferenceReference' required: - url - valueReference PractitionerRoleItemExtensionValueReferenceReference: type: object properties: reference: type: string required: - reference PractitionerRoleItemHealthcareService: type: object properties: reference: type: string required: - reference PractitionerRoleItemIdentifier: type: object properties: system: type: string value: type: string required: - system - value PractitionerRoleItemLocation: type: object properties: reference: type: string required: - reference PractitionerRoleItemOrganization: type: object properties: reference: type: string display: type: string required: - display - reference PractitionerRoleItemPractitioner: type: object properties: reference: type: string display: type: string required: - display - reference PractitionerRoleItemResponse: type: object properties: resourceType: type: string id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseResourceMeta' description: Metadata about the resource text: allOf: - $ref: '#/components/schemas/BaseResourceText' description: Text summary of the resource, for human interpretation identifier: type: array items: $ref: '#/components/schemas/PractitionerRoleItemIdentifier' description: Business Identifiers that are specific to a role/location active: type: boolean description: Whether this practitioner role record is in active use extension: type: array items: $ref: '#/components/schemas/PractitionerRoleItemExtensionValue' practitioner: allOf: - $ref: '#/components/schemas/PractitionerRoleItemPractitioner' description: Practitioner that is able to provide the defined services for the organization organization: allOf: - $ref: '#/components/schemas/PractitionerRoleItemOrganization' description: Organization where the roles are available location: type: array items: $ref: '#/components/schemas/PractitionerRoleItemLocation' description: The location(s) at which this practitioner provides care healthcareService: type: array items: $ref: '#/components/schemas/PractitionerRoleItemHealthcareService' description: The list of healthcare services that this worker provides for this role's Organization/Location(s) endpoint: allOf: - $ref: '#/components/schemas/PractitionerRoleItemEndpoint' description: Technical endpoints providing access to services operated for the practitioner with this role code: type: array items: $ref: '#/components/schemas/PractitionerRoleItemCode' description: Roles which this practitioner may perform specialty: type: array items: $ref: '#/components/schemas/PractitionerRoleItemSpecialty' description: Specific specialty of the practitioner required: - active - extension - id - identifier - meta - resourceType - text PractitionerRoleItemSpecialty: type: object properties: coding: type: array items: $ref: '#/components/schemas/PractitionerRoleItemCoding' required: - coding PractitionerRoleSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: allOf: - $ref: '#/components/schemas/PractitionerRoleItemResponse' description: A resource in the bundle required: - fullUrl - resource - search PractitionerRoleSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/PractitionerRoleSearchEntry' description: "Entry in the bundle - will have a resource or information\n\n- Rule: must be a resource unless there's a request or response\n- Rule: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type\n \ " required: - entry - id - link - meta - resourceType - total - type PractitionerSearchEntry: type: object properties: fullUrl: type: string description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) search: allOf: - $ref: '#/components/schemas/BaseBundleSearch' description: Search related information resource: $ref: '#/components/schemas/PractitionerGetResponse' required: - fullUrl - resource - search PractitionerSearchResponse: type: object properties: resourceType: type: string description: Bundle id: type: string description: Logical id of this artifact meta: allOf: - $ref: '#/components/schemas/BaseBundleMeta' description: Metadata about the resource type: $ref: '#/components/schemas/TypeF76Enum' total: type: integer minimum: 0 description: If search, the total number of matches link: type: array items: $ref: '#/components/schemas/BaseBundleLink' description: Links related to this Bundle timestamp: type: string format: date-time description: When the bundle was assembled signature: allOf: - $ref: '#/components/schemas/BaseBundleSignature' description: Digital Signature identifier: description: Persistent identifier for the bundle language: type: string description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html' implicitRules: type: string description: A set of rules under which this content was created entry: type: array items: $ref: '#/components/schemas/PractitionerSearchEntry' required: - entry - id - link - meta - resourceType - total - type PublicationStatusEnum: enum: - draft - active - retired - unknown type: string description: |- * `draft` - draft * `active` - active * `retired` - retired * `unknown` - unknown ResponseModeEnum: enum: - working - snapshot - changes type: string description: |- * `working` - working * `snapshot` - snapshot * `changes` - changes SearchModeEnum: enum: - match - include - outcome type: string description: |- * `match` - match * `include` - include * `outcome` - outcome SystemEnum: enum: - phone - fax - email - pager - url - sms - other type: string description: |- * `phone` - phone * `fax` - fax * `email` - email * `pager` - pager * `url` - url * `sms` - sms * `other` - other TypeF76Enum: enum: - document - message - transaction - transaction - response - batch - batch - response - history - searchset - collection type: string description: |- * `document` - document * `message` - message * `transaction` - transaction * `transaction - response` - transaction - response * `batch` - batch * `batch - response` - batch - response * `history` - history * `searchset` - searchset * `collection` - collection securitySchemes: basicAuth: type: http scheme: basic cookieAuth: type: apiKey in: cookie name: sessionid