Mobile Navigation

IMPORTANT: Are you enrolled in Medi-Cal? Has your contact information changed in the past two years? Give your county office your updated contact information so you can stay enrolled. Go to benefitscal.com or call the Los Angeles County Department of Public Social Services at 1-866-613-3777

Provider Directory API

Base URL:

https://interoperability.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/

 

List of Provider Directory APIs

For currently available functionality, please retrieve LA Care's Da Vinci PlanNet CapabilityStatement.

Note: API Descriptions are pulled from DaVinci PDEX Plan Net 1.0.0 - STU1. For currently available functionality, please retrieve LA Care's Da Vinci PlanNet CapabilityStatement.

Description of API from DaVinci PDEX Plan Net 1.0.0 - STU1

Based on HL7® FHIR© R4:
https://www.hl7.org/fhir/

Da Vinci PlanNet Implementation Guide:
https://hl7.org/fhir/us/davinci-pdex-plan-net/STU1/

 

Capability Statement

The Capability Statement describes the expected capabilities of the Plan-Net Server actor which is responsible for providing responses to the queries submitted by the Plan-Net Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Plan-Net Servers are defined. Plan-Net Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.

 

Endpoint - (PlannetEndpoint)

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

 

Health Care Service - (PlannetHealthcareService)

The Health Care Service resource typically describes services offered by an organization/practitioner at a location. The resource may be used to encompass a variety of services covering the entire healthcare spectrum, including promotion, prevention, diagnostics, hospital and ambulatory care, home care, long-term care, and other health-related and community services.

 

Insurance Plan - (PlannetInsurancePlan)

An InsurancePlan is a discrete package of health insurance coverage benefits that are offered under a particular network type. A given payer’s products typically differ by network type and/or covered benefits. A plan pairs a product’s covered benefits with the particular cost sharing structure offered to a consumer. A given product may comprise multiple plans (i.e. each plan offers different cost sharing requirements for the same set of covered benefits).

Insurance Plan describes a health insurance offering comprised of a list of covered benefits (i.e. the product), costs associated with those benefits (i.e. the plan), and additional information about the offering, such as who it is owned and administered by, a coverage area, contact information, etc.

 

Location - (PlannetLocation)

A Location is the physical place where healthcare services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.

 

Organization - (PlannetNetwork)

A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. A network is typically owned by a payer.

In the PlanNet IG, individuals and organizations are represented as participants in a Plan-Net Network through the PlannetPractitionerRole and PlannetOrganizationAffiliation resources, respectively.

 

Organization - (PlannetOrganization)

An Organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice.

 

Organization Affiliation - (PlannetOrganizationAffiliation)

The Organization Affiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints, and other relevant information.

 

Practitioner - (PlannetPractitioner)

Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.

 

Practitioner Role - (PlannetPractitionerRole)

Practitioner Role describes the role a practitioner plays at an organization, including the services they provide, the location(s) where they work, and their availability, electronic endpoints, and other relevant information.

 

Provider Directory API Response Codes

 

HTTP Response/Exception Codes Response/Exception Code Definition Return Type
200 Success Bundle or Resource
400 Invalid parameter OperationOutcome/Error
404 Unknown resource OperationOutcome/Error
401 Unauthorized request OperationOutcome/Error
Content CTA: 
Capability Statement

CapabilityStatement

Retrieve the CapabilityStatement

Syntax: GET [Base URL]/metadata

Interaction Definition Parameter Type Return Type
metadata Capabilities interaction: Returns a CapabilityStatement describing the server's current operational functionality N/A CapabilityStatement
Endpoint

Search for Endpoints

Syntax: GET [Base URL]/Endpoint?{[parameter=value]}

Endpoint: HL7 FHIR R4 Endpoint resource conformant to PlanNetEndpoint 1.0.0

GET /Endpoint search-type: Search for Endpoints

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (Endpoint) String Bundle
_lastUpdated When the resource (Endpoint) version last changed String Bundle
organization Select Endpoints managed by the specified organization String Bundle
_has Select Endpoints based on the properties of resources that refer to them String Bundle
_include Include additional resources referenced from returned search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Bundle",
    "id": "fa457398-0889-498e-bab9-182a8d54822c",
    "meta": {
      "lastUpdated": "2022-02-01T07:07:55.364-08:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/Endpoint?_id=PractitionerRole.endpoint"
      }
    ],
    "entry": [
      {
        "fullUrl": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/Endpoint/PractitionerRole.endpoint",
        "resource": {
          "resourceType": "Endpoint",
          "id": "PractitionerRole.endpoint",
          "meta": {
            "lastUpdated": "2021-06-01T00:00:00.000-07:00",
            "profile": [
              "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint"
            ]
          },
          "language": "en-US",
          "text": {
            "status": "generated",
            "div": "Generated narrative with details id: PractitionerRole.endpoint"
          },
          "extension": [
            {
              "extension": [
                {
                  "url": "type",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
                        "code": "HOPERAT",
                        "display": "healthcare operations"
                      }
                    ]
                  }
                }
              ],
              "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase"
            }
          ],
          "status": "active",
          "connectionType": {
            "system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
            "code": "hl7-fhir-rest",
            "display": "HL7 FHIR"
          },
          "name": "Endpoint for PractitionerRole",
          "contact": [
            {
              "system": "phone",
              "value": "(877) 431-2273"
            },
            {
              "system": "url",
              "value": "https://wwww.lacare.org"
            }
          ],
          "payloadType": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS",
                  "code": "NA",
                  "display": "Not Applicable"
                }
              ],
              "text": "Not Applicable"
            }
          ],
          "payloadMimeType": ["application/fhir+xml", "application/fhir+json"],
          "address": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/PractitionerRole"
        },
        "search": {
          "mode": "match"
        }
      }
    ]
    }

GET /Endpoint/[id] read-instance: Read a specific Endpoint

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (Endpoint) String Resource

Sample Response (Read)

  
    {
    "resourceType": "Endpoint",
    "id": "PractitionerRole.endpoint",
    "meta": {
      "lastUpdated": "2021-06-01T00:00:00.000-07:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id: PractitionerRole.endpoint"
    },
    "extension": [
      {
        "extension": [
          {
            "url": "type",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
                  "code": "HOPERAT",
                  "display": "healthcare operations"
                }
              ]
            }
          }
        ],
        "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/endpoint-usecase"
      }
    ],
    "status": "active",
    "connectionType": {
      "system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
      "code": "hl7-fhir-rest",
      "display": "HL7 FHIR"
    },
    "name": "Endpoint for PractitionerRole",
    "contact": [
      {
        "system": "phone",
        "value": "(877) 431-2273"
      },
      {
        "system": "url",
        "value": "https://wwww.lacare.org"
      }
    ],
    "payloadType": [
      {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS",
            "code": "NA",
            "display": "Not Applicable"
          }
        ],
        "text": "Not Applicable"
      }
    ],
    "payloadMimeType": ["application/fhir+xml", "application/fhir+json"],
    "address": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/PractitionerRole"
    }
Healthcare Service

Search for HealthcareService

Syntax: GET [Base URL]/HealthcareService?{[parameter=value]}

HealthcareService: HL7 FHIR R4 HealthcareService resource conformant to PlannetHealthcareService 1.0.0

GET /HealthcareService search-type: Search for HealthcareService

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (HealthcareService) String Bundle
_lastUpdated When the resource (HealthcareService) version last changed String Bundle
location Select HealthcareServices available at the specified location String Bundle
coverage-area Select services available in a region described by the specified location String Bundle
organization Select HealthcareServices provided by the specified organization String Bundle
endpoint Select HealthcareServices with the specified endpoint String Bundle
name Select HealthcareServices with the specified name String Bundle
service-category Select HealthcareServices providing the specified category of services String Bundle
service-type Select HealthcareServices of the specified type String Bundle
specialty Select services associated with the specified specialty String Bundle
_has Select HealthcareServices based on the properties of resources that refer to them String Bundle
_include Include additional resources referenced from returned search results in search results String Bundle
_revinclude Include additional resources with references to matching search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Bundle",
    "id": "22e42158-65f9-46f2-bd93-e9dc1f6c72c1",
    "meta": {
      "lastUpdated": "2022-01-31T02:12:36.145-08:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/HealthcareService?_id=625452"
      }
    ],
    "entry": [
      {
        "fullUrl": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/HealthcareService/625452",
        "resource": {
          "resourceType": "HealthcareService",
          "id": "625452",
          "meta": {
            "lastUpdated": "2021-07-08T02:39:45.000-08:00",
            "profile": [
              "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService"
            ]
          },
          "language": "en-US",
          "text": {
            "status": "generated",
            "div": "Generated narrative with details id: 625452"
          },
          "extension": [
            {
              "extension": [
                {
                  "url": "type",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS",
                        "code": "physical"
                      }
                    ]
                  }
                }
              ],
              "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method"
            }
          ],
          "active": true,
          "category": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS",
                  "code": "prov"
                }
              ]
            }
          ],
          "specialty": [
            {
              "coding": [
                {
                  "system": "http://nucc.org/provider-taxonomy",
                  "code": "208600000X"
                }
              ]
            }
          ],
          "location": [
            {
              "reference": "Location/98544"
            }
          ],
          "availableTime": [
            {
              "daysOfWeek": ["mon"],
              "availableStartTime": "08:00:00",
              "availableEndTime": "16:00:00"
            },
            {
              "daysOfWeek": ["tue"],
              "availableStartTime": "08:00:00",
              "availableEndTime": "16:00:00"
            },
            {
              "daysOfWeek": ["wed"],
              "availableStartTime": "08:00:00",
              "availableEndTime": "16:00:00"
            },
            {
              "daysOfWeek": ["thu"],
              "availableStartTime": "08:00:00",
              "availableEndTime": "16:00:00"
            },
            {
              "daysOfWeek": ["fri"],
              "availableStartTime": "08:00:00",
              "availableEndTime": "16:00:00"
            }
          ]
        },
        "search": {
          "mode": "match"
        }
      }
    ]
    }

Syntax: GET/HealthcareService/[id] read-instance: Read a specific HealthcareService

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (HealthcareService) String Resource

Sample Response (Read)

  
    {
    "resourceType": "HealthcareService",
    "id": "625452",
    "meta": {
      "lastUpdated": "2021-07-08T02:39:45.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id : 625452"
    },
    "extension": [
      {
        "extension": [
          {
            "url": "type",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS",
                  "code": "physical"
                }
              ]
            }
          }
        ],
        "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method"
      }
    ],
    "active": true,
    "category": [
      {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS",
            "code": "prov"
          }
        ]
      }
    ],
    "specialty": [
      {
        "coding": [
          {
            "system": "http://nucc.org/provider-taxonomy",
            "code": "208600000X"
          }
        ]
      }
    ],
    "location": [
      {
        "reference": "Location/98544"
      }
    ],
    "availableTime": [
      {
        "daysOfWeek": ["mon"],
        "availableStartTime": "08:00:00",
        "availableEndTime": "16:00:00"
      },
      {
        "daysOfWeek": ["tue"],
        "availableStartTime": "08:00:00",
        "availableEndTime": "16:00:00"
      },
      {
        "daysOfWeek": ["wed"],
        "availableStartTime": "08:00:00",
        "availableEndTime": "16:00:00"
      },
      {
        "daysOfWeek": ["thu"],
        "availableStartTime": "08:00:00",
        "availableEndTime": "16:00:00"
      },
      {
        "daysOfWeek": ["fri"],
        "availableStartTime": "08:00:00",
        "availableEndTime": "16:00:00"
      }
    ]
    }
Insurance Plan

Search for InsurancePlan

Syntax: GET [Base URL]/InsurancePlan?{[parameter=value]}

InsurancePlan: HL7 FHIR R4 InsurancePlan resource conformant to PlannetInsurancePlan 1.0.0

GET /InsurancePlan search-type: Search for InsurancePlan

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (InsurancePlan) String Bundle
_lastUpdated When the resource (InsurancePlan) version last changed String Bundle
administered-by Select products that are administered by the specified organization String Bundle
owned-by Select products that are owned by the specified organization String Bundle
coverage-area Select products that are offered in the specified location String Bundle
name Select products with the specified name String Bundle
plan-type Select plans of the specified type String Bundle
identifier Select products with the specified identifier String Bundle
type Select insurance plans of the specified type String Bundle
_has Select InsurancePlans based on the properties of resources that refer to them String Bundle
_include Include additional resources referenced from returned search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Bundle",
    "id": "0b63fc9c-4abe-460b-be01-1ec91ab1c755",
    "meta": {
      "lastUpdated": "2022-02-01T07:15:26.973-08:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/InsurancePlan?_id=124"
      }
    ],
    "entry": [
      {
        "fullUrl": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/InsurancePlan/124",
        "resource": {
          "resourceType": "InsurancePlan",
          "id": "124",
          "meta": {
            "lastUpdated": "2021-07-08T12:00:00.000-08:00",
            "profile": [
              "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan"
            ]
          },
          "language": "en-US",
          "text": {
            "status": "generated",
            "div": "Generated narrative with details id: 124"
          },
          "status": "active",
          "type": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS",
                  "code": "qhp"
                }
              ]
            }
          ],
          "name": "Qualified Health Plan",
          "ownedBy": {
            "reference": "Organization/1"
          },
          "administeredBy": {
            "reference": "Organization/1"
          },
          "network": [
            {
              "reference": "Organization/474"
            },
            {
              "reference": "Organization/478"
            },
            {
              "reference": "Organization/490"
            },
            {
              "reference": "Organization/500"
            },
            {
              "reference": "Organization/532"
            },
            {
              "reference": "Organization/538"
            },
            {
              "reference": "Organization/560"
            },
            {
              "reference": "Organization/562"
            },
            {
              "reference": "Organization/568"
            },
            {
              "reference": "Organization/572"
            },
            {
              "reference": "Organization/578"
            },
            {
              "reference": "Organization/582"
            },
            {
              "reference": "Organization/594"
            },
            {
              "reference": "Organization/618"
            },
            {
              "reference": "Organization/638"
            },
            {
              "reference": "Organization/644"
            },
            {
              "reference": "Organization/650"
            },
            {
              "reference": "Organization/674"
            },
            {
              "reference": "Organization/678"
            },
            {
              "reference": "Organization/696"
            }
          ]
        },
        "search": {
          "mode": "match"
        }
      }
    ]
    }

Syntax: GET [Base URL]/InsurancePlan/[id] read-instance: Read a specific InsurancePlan

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (InsurancePlan) String Resource

Sample Response (Read)

  
    {
    "resourceType": "InsurancePlan",
    "id": "124",
    "meta": {
      "lastUpdated": "2021-07-08T12:00:00.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id: 124"
    },
    "status": "active",
    "type": [
      {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS",
            "code": "qhp"
          }
        ]
      }
    ],
    "name": "Qualified Health Plan",
    "ownedBy": {
      "reference": "Organization/1"
    },
    "administeredBy": {
      "reference": "Organization/1"
    },
    "network": [
      {
        "reference": "Organization/474"
      },
      {
        "reference": "Organization/478"
      },
      {
        "reference": "Organization/490"
      },
      {
        "reference": "Organization/500"
      },
      {
        "reference": "Organization/532"
      },
      {
        "reference": "Organization/538"
      },
      {
        "reference": "Organization/560"
      },
      {
        "reference": "Organization/562"
      },
      {
        "reference": "Organization/568"
      },
      {
        "reference": "Organization/572"
      },
      {
        "reference": "Organization/578"
      },
      {
        "reference": "Organization/582"
      },
      {
        "reference": "Organization/594"
      },
      {
        "reference": "Organization/618"
      },
      {
        "reference": "Organization/638"
      },
      {
        "reference": "Organization/644"
      },
      {
        "reference": "Organization/650"
      },
      {
        "reference": "Organization/674"
      },
      {
        "reference": "Organization/678"
      },
      {
        "reference": "Organization/696"
      }
    ]
    }
Location

Search for Location

Syntax: GET [Base URL]/Location?{[parameter=value]}

Location: HL7 FHIR R4 Location resource conformant to PlannetLocation 1.0.0

GET /Location search-type: Search for Location

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (Location) String Bundle
_lastUpdated When the resource (Location) version last changed String Bundle
partof Select Locations that are part of the specified location String Bundle
organization Select Locations managed by the specified organization String Bundle
endpoint Select Locations with the specified endpoint String Bundle
address-city Select Locations with the specified address.city String Bundle
address-state Select Locations with the specified address.state String Bundle
address-postalcode Select Locations with the specified address.postalCode String Bundle
address Select Locations with the specified address String Bundle
type Select Locations of the specified type String Bundle
_has Select Locations based on the properties of resources that refer to them String Bundle
_include Include additional resources referenced from returned search results in search results String Bundle
_revinclude Include additional resources with references to matching search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Bundle",
    "id": "e969f10c-50e3-40fd-b067-ec2b31defe03",
    "meta": {
      "lastUpdated": "2022-01-27T08:19:50.927-08:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/Location?address=13063%20ROSECRANS%20AVE"
      }
    ],
    "entry": [
      {
        "fullUrl": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/Location/98826",
        "resource": {
          "resourceType": "Location",
          "id": "98826",
          "meta": {
            "lastUpdated": "2021-07-08T02:34:48.000-08:00",
            "profile": [
              "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"
            ]
          },
          "language": "en-US",
          "text": {
            "status": "generated",
            "div": "Generated narrative with details id: 98826"
          },
          "status": "active",
          "name": "13063 ROSECRANS AVE  SANTA FE SPRINGS LOS ANGELES CA 90670",
          "address": {
            "line": ["13063 ROSECRANS AVE"],
            "city": "SANTA FE SPRINGS",
            "state": "CA",
            "postalCode": "90670",
            "country": "USA"
          }
        },
        "search": {
          "mode": "match"
        }
      }
    ]
    }

Syntax: GET [Base URL]/Location/[id] read-instance: Read a specific Location

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (Location) String Resource

Sample Response (Read)

  
    {
    "resourceType": "Location",
    "id": "98826",
    "meta": {
      "lastUpdated": "2021-07-08T02:34:48.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with detailsid: 98826"
    },
    "status": "active",
    "name": "13063 ROSECRANS AVE  SANTA FE SPRINGS LOS ANGELES CA 90670",
    "address": {
      "line": ["13063 ROSECRANS AVE"],
      "city": "SANTA FE SPRINGS",
      "state": "CA",
      "postalCode": "90670",
      "country": "USA"
    }
    }
Organization

Search for Organization

Syntax: GET [Base URL]/Organization?{[parameter=value]}

Organization: HL7 FHIR R4 Organization resource conformant to PlannetNetwork 1.0.0 or PlannetOrganization 1.0.0

GET /Organization search-type: Search for Organization

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (Organization) String Bundle
_lastUpdated When the resource (Organization) version last changed String Bundle
partof Select Organizations that are part of the specified organization String Bundle
endpoint Select Organizations with the specified endpoint String Bundle
address Select organizations with the specified address (matches any of the string elements of an address) String Bundle
name Select Organizations with the specified name String Bundle
type Select Organizations of the specified type String Bundle
coverage-area Select health insurance provider networks available in a region described by the specified location String Bundle
_has Select Organizations based on the properties of resources that refer to them String Bundle
_include Include additional resources referenced from returned search results in search results String Bundle
_revinclude Include additional resources with references to matching search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Bundle",
    "id": "492254cb-dea6-4386-89d6-d7d5dc5b74a0",
    "meta": {
      "lastUpdated": "2022-01-31T02:00:25.658-08:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/Organization?_id=2143"
      }
    ],
    "entry": [
      {
        "fullUrl": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/Organization/2143",
        "resource": {
          "resourceType": "Organization",
          "id": "2143",
          "meta": {
            "lastUpdated": "2021-07-08T02:21:43.000-08:00",
            "profile": [
              "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization"
            ]
          },
          "language": "en-US",
          "text": {
            "status": "generated",
            "div": "Generated narrative with details id: 2143"
          },
          "active": true,
          "type": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS",
                  "code": "fac"
                }
              ]
            }
          ],
          "name": "CARSON DIALYSIS",
          "telecom": [
            {
              "system": "fax",
              "value": "(310) 513-1581"
            },
            {
              "system": "phone",
              "value": "(310) 513-1427"
            }
          ],
          "address": [
            {
              "line": ["1309 E CARSON STREET"],
              "city": "CARSON",
              "state": "CA",
              "postalCode": "90745",
              "country": "USA"
            }
          ]
        },
        "search": {
          "mode": "match"
        }
      }
    ]
    }

Syntax: GET [Base URL]/Organization/[id] read-instance: Read a specific Organization

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (Organization) String Resource

Sample Response (Read)

  
    {
    "resourceType": "Organization",
    "id": "2143",
    "meta": {
      "lastUpdated": "2021-07-08T02:21:43.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id: 2143"
    },
    "active": true,
    "type": [
      {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS",
            "code": "fac"
          }
        ]
      }
    ],
    "name": "CARSON DIALYSIS",
    "telecom": [
      {
        "system": "fax",
        "value": "(310) 513-1581"
      },
      {
        "system": "phone",
        "value": "(310) 513-1427"
      }
    ],
    "address": [
      {
        "line": ["1309 E CARSON STREET"],
        "city": "CARSON",
        "state": "CA",
        "postalCode": "90745",
        "country": "USA"
      }
    ]
    }
Organization Affiliation

Search for OrganizationAffiliation

Syntax: GET [Base URL]/OrganizationAffiliation?{[parameter=value]}

OrganizationAffiliation: HL7 FHIR R4 OrganizationAffiliation resource conformant to PlannetOrganizationAffiliation 1.0.0

GET /OrganizationAffiliation search-type: Search for OrganizationAffiliation

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (OrganizationAffiliation) String Bundle
_lastUpdated When the resource (OrganizationAffiliation) version last changed String Bundle
primary-organization Select roles offered by the specified organization String Bundle
participating-organization Select roles filled by the specified organization String Bundle
location Select OrganizationAffiliations available at the specified location String Bundle
service Select OrganizationAffiliations providing the specified service String Bundle
network Select roles where the organization is a member of the specified health insurance provider network String Bundle
endpoint Select OrganizationAffiliations with the specified endpoint String Bundle
role Select OrganizationAffiliations with the specified role String Bundle
specialty Select OrganizationAffiliations associated with the specified specialty String Bundle
_has Select OrganizationAffiliations based on the properties of resources that refer to them String Bundle
_include Include additional resources referenced from returned search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Bundle",
    "id": "23129dda-0194-42ff-b566-633f365493ae",
    "meta": {
      "lastUpdated": "2022-02-01T07:21:30.533-08:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/OrganizationAffiliation?_id=36669"
      }
    ],
    "entry": [
      {
        "fullUrl": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/OrganizationAffiliation/36669",
        "resource": {
          "resourceType": "OrganizationAffiliation",
          "id": "36669",
          "meta": {
            "lastUpdated": "2021-07-14T10:30:09.000-08:00",
            "profile": [
              "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation"
            ]
          },
          "language": "en-US",
          "text": {
            "status": "generated",
            "div": "Generated narrative with details id: 36669"
          },
          "active": true,
          "organization": {
            "reference": "Organization/741"
          },
          "network": [
            {
              "reference": "Organization/578"
            }
          ],
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS",
                  "code": "hospice"
                }
              ]
            }
          ],
          "specialty": [
            {
              "coding": [
                {
                  "system": "http://nucc.org/provider-taxonomy",
                  "code": "251T00000X"
                }
              ]
            }
          ],
          "location": [
            {
              "reference": "Location/101911"
            }
          ],
          "healthcareService": [
            {
              "reference": "HealthcareService/636036"
            }
          ],
          "telecom": [
            {
              "system": "phone",
              "value": "(323) 266-6700"
            }
          ]
        },
        "search": {
          "mode": "match"
        }
      }
    ]
    }

Syntax: GET [Base URL]/OrganizationAffiliation/[id] read-instance: Read a specific OrganizationAffiliation

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (OrganizationAffiliation) String Resource

Sample Response (Read)

  
    {
    "resourceType": "OrganizationAffiliation",
    "id": "36669",
    "meta": {
      "lastUpdated": "2021-07-14T10:30:09.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id: 36669"
    },
    "active": true,
    "organization": {
      "reference": "Organization/741"
    },
    "network": [
      {
        "reference": "Organization/578"
      }
    ],
    "code": [
      {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS",
            "code": "hospice"
          }
        ]
      }
    ],
    "specialty": [
      {
        "coding": [
          {
            "system": "http://nucc.org/provider-taxonomy",
            "code": "251T00000X"
          }
        ]
      }
    ],
    "location": [
      {
        "reference": "Location/101911"
      }
    ],
    "healthcareService": [
      {
        "reference": "HealthcareService/636036"
      }
    ],
    "telecom": [
      {
        "system": "phone",
        "value": "(323) 266-6700"
      }
    ]
    }
Practitioner

Search for Practitioner

Syntax: GET [Base URL]/Practitioner?{[parameter=value]}

Practitioner: HL7 FHIR R4 Practitioner resource conformant to PlannetPractitioner 1.0.0

GET /Practitioner search-type: Search for Practitioner

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (Practitioner) String Bundle
_lastUpdated When the resource (Practitioner) version last changed String Bundle
name Select Practitioners with the specified name (matches against any of the elements in the HumanName data type) String Bundle
family Select Practitioners with the specified family name String Bundle
given Select Practitioners with the specified given name String Bundle
_has Select Practitioners based on the properties of resources that refer to them String Bundle
_revinclude Include additional resources with references to matching search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Practitioner",
    "id": "93005",
    "meta": {
      "lastUpdated": "2021-07-08T12:00:00.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id : 93005"
    },
    "identifier": [
      {
        "system": "http://hl7.org/fhir/sid/us-npi",
        "value": "1952505125"
      },
      {
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
              "code": "MD"
            }
          ]
        },
        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
        "value": "A97760"
      }
    ],
    "active": true,
    "name": [
      {
        "text": "HRACHYA PARUYRYAN",
        "family": "PARUYRYAN",
        "given": ["HRACHYA"],
        "suffix": ["MD"]
      }
    ],
    "qualification": [
      {
        "code": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
              "code": "MD"
            }
          ]
        }
      }
    ],
    "communication": [
      {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "hy"
          },
          {
            "system": "urn:ietf:bcp:47",
            "code": "ru"
          }
        ]
      }
    ]
    }

Syntax: GET [Base URL]/Practitioner/[id] read-instance: Read a specific Practitioner

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (Practitioner) String Resource

Sample Response (Read)

  
    {
    "resourceType": "Practitioner",
    "id": "93005",
    "meta": {
      "lastUpdated": "2021-07-08T12:00:00.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id: 93005"
    },
    "identifier": [
      {
        "system": "http://hl7.org/fhir/sid/us-npi",
        "value": "1952505125"
      },
      {
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
              "code": "MD"
            }
          ]
        },
        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
        "value": "A97760"
      }
    ],
    "active": true,
    "name": [
      {
        "text": "HRACHYA PARUYRYAN",
        "family": "PARUYRYAN",
        "given": ["HRACHYA"],
        "suffix": ["MD"]
      }
    ],
    "qualification": [
      {
        "code": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
              "code": "MD"
            }
          ]
        }
      }
    ],
    "communication": [
      {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "hy"
          },
          {
            "system": "urn:ietf:bcp:47",
            "code": "ru"
          }
        ]
      }
    ]
    }
Practitioner Role

Search for PractitionerRole

Syntax: GET [Base URL]/PractitionerRole?{[parameter=value]}

PractitionerRole: HL7 FHIR R4 PractitionerRole resource conformant to PlannetPractitionerRole 1.0.0

GET /PractitionerRole search-type: Search for PractitionerRole

Supported Searches Search Parameter Definition Parameter Type Return Type
_id Logical ID of the Resource (PractitionerRole) String Bundle
_lastUpdated When the resource (PractitionerRole) version last changed String Bundle
practitioner Select roles filled by the specified practitioner String Bundle
organization Select PractitionerRoles available at the specified organization String Bundle
location Select PractitionerRoles available at the specified location String Bundle
service Select PractitionerRoles providing the specified service String Bundle
network Select roles where the practitioner is a member of the specified health insurance provider network String Bundle
endpoint Select PractitionerRoles with the specified endpoint String Bundle
role Select PractitionerRoles with the specified role String Bundle
specialty Select PractitionerRoles associated with the specified specialty String Bundle
_has Select PractitionerRoles based on the properties of resources that refer to them String Bundle
_include Include additional resources referenced from returned search results in search results String Bundle

Sample Response (Search)

  
    {
    "resourceType": "Bundle",
    "id": "45a7ad3a-42d4-4a09-bf43-be86f79e3246",
    "meta": {
      "lastUpdated": "2022-01-26T01:45:26.099-08:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/PractitionerRole?_id=3461817"
      }
    ],
    "entry": [
      {
        "fullUrl": "https://oauthq.lacare.org/fhir/us/davinci-pdex-plan-net-v1/api/PractitionerRole/3461817",
        "resource": {
          "resourceType": "PractitionerRole",
          "id": "3461817",
          "meta": {
            "lastUpdated": "2021-07-08T12:00:00.000-08:00",
            "profile": [
              "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole"
            ]
          },
          "language": "en-US",
          "text": {
            "status": "generated",
            "div": "Generated narrative with details id: 3461817"
          },
          "extension": [
            {
              "extension": [
                {
                  "url": "acceptingPatients",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS",
                        "code": "newpt"
                      }
                    ]
                  }
                },
                {
                  "url": "fromNetwork",
                  "valueReference": {
                    "reference": "Organization/638"
                  }
                }
              ],
              "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients"
            },
            {
              "extension": [
                {
                  "url": "code",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
                        "code": "MD"
                      }
                    ]
                  }
                },
                {
                  "url": "status",
                  "valueCode": "active"
                }
              ],
              "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification"
            },
            {
              "extension": [
                {
                  "url": "code",
                  "valueCodeableConcept": {
                    "coding": [
                      {
                        "system": "http://nucc.org/provider-taxonomy",
                        "code": "207Q00000X"
                      }
                    ]
                  }
                },
                {
                  "url": "status",
                  "valueCode": "active"
                }
              ],
              "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification"
            }
          ],
          "active": true,
          "practitioner": {
            "reference": "Practitioner/93038"
          },
          "organization": {
            "reference": "Organization/1715"
          },
          "location": [
            {
              "reference": "Location/102018"
            }
          ],
          "telecom": [
            {
              "system": "phone",
              "value": "(626) 447-4567"
            },
            {
              "system": "fax",
              "value": "(626) 447-4585"
            }
          ],
          "availableTime": [
            {
              "daysOfWeek": ["mon"],
              "allDay": false,
              "availableStartTime": "08:30:00",
              "availableEndTime": "17:00:00"
            },
            {
              "daysOfWeek": ["tue"],
              "allDay": false,
              "availableStartTime": "08:30:00",
              "availableEndTime": "15:00:00"
            },
            {
              "daysOfWeek": ["wed"],
              "allDay": false,
              "availableStartTime": "08:30:00",
              "availableEndTime": "15:00:00"
            },
            {
              "daysOfWeek": ["thu"],
              "allDay": false,
              "availableStartTime": "05:30:00",
              "availableEndTime": "17:00:00"
            },
            {
              "daysOfWeek": ["fri"],
              "allDay": false,
              "availableStartTime": "08:30:00",
              "availableEndTime": "17:00:00"
            }
          ]
        },
        "search": {
          "mode": "match"
        }
      }
    ]
    }

Syntax: GET [Base URL]/PractitionerRole/[id] read-instance: Read a specific PractitionerRole

Read Read Definition Parameter Type Return Type
id Logical ID of the Resource (PractitionerRole) String Resource

Sample Response (Read)

  
    {
    "resourceType": "PractitionerRole",
    "id": "3461817",
    "meta": {
      "lastUpdated": "2021-07-08T12:00:00.000-08:00",
      "profile": [
        "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole"
      ]
    },
    "language": "en-US",
    "text": {
      "status": "generated",
      "div": "Generated narrative with details id: 3461817"
    },
    "extension": [
      {
        "extension": [
          {
            "url": "acceptingPatients",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS",
                  "code": "newpt"
                }
              ]
            }
          },
          {
            "url": "fromNetwork",
            "valueReference": {
              "reference": "Organization/638"
            }
          }
        ],
        "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients"
      },
      {
        "extension": [
          {
            "url": "code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
                  "code": "MD"
                }
              ]
            }
          },
          {
            "url": "status",
            "valueCode": "active"
          }
        ],
        "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification"
      },
      {
        "extension": [
          {
            "url": "code",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://nucc.org/provider-taxonomy",
                  "code": "207Q00000X"
                }
              ]
            }
          },
          {
            "url": "status",
            "valueCode": "active"
          }
        ],
        "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification"
      }
    ],
    "active": true,
    "practitioner": {
      "reference": "Practitioner/93038"
    },
    "organization": {
      "reference": "Organization/1715"
    },
    "location": [
      {
        "reference": "Location/102018"
      }
    ],
    "telecom": [
      {
        "system": "phone",
        "value": "(626) 447-4567"
      },
      {
        "system": "fax",
        "value": "(626) 447-4585"
      }
    ],
    "availableTime": [
      {
        "daysOfWeek": ["mon"],
        "allDay": false,
        "availableStartTime": "08:30:00",
        "availableEndTime": "17:00:00"
      },
      {
        "daysOfWeek": ["tue"],
        "allDay": false,
        "availableStartTime": "08:30:00",
        "availableEndTime": "15:00:00"
      },
      {
        "daysOfWeek": ["wed"],
        "allDay": false,
        "availableStartTime": "08:30:00",
        "availableEndTime": "15:00:00"
      },
      {
        "daysOfWeek": ["thu"],
        "allDay": false,
        "availableStartTime": "05:30:00",
        "availableEndTime": "17:00:00"
      },
      {
        "daysOfWeek": ["fri"],
        "allDay": false,
        "availableStartTime": "08:30:00",
        "availableEndTime": "17:00:00"
      }
    ]
    }