GET PlanCare2Api/ClientplansV2/{clientplanId}/omaha

Retrieve the Omaha System structure of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientplanId	The clientplan ID.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of ClientplanOmahaDomain

Collection of ClientplanOmahaDomain

Name	Description	Type	Additional information
Id	The id of the domain	integer	-
Name	The name of the domain	string	-
Index	The index of the domain	integer	-
Areas	Collection of ClientplanOmahaAreas that are related to the ClientplanOmahaDomain	Collection of ClientplanOmahaArea	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "Index": 3,
    "Areas": [
      {
        "$id": "2",
        "Id": "d7c06414-c7b4-4596-b649-43137d6534c3",
        "AreaId": 2,
        "Area": "sample string 3",
        "RangeId": 4,
        "Range": "sample string 5",
        "TypificationId": 6,
        "Typification": "sample string 7",
        "Remarks": "sample string 8",
        "Symptoms": [
          {
            "$id": "3",
            "Id": 1,
            "Term": "sample string 2"
          },
          {
            "$ref": "3"
          }
        ],
        "Interventions": [
          {
            "$id": "4",
            "Id": "99edb1df-1eae-4f76-8baa-d59ed9b9b54c",
            "ActionAreaId": 2,
            "ActionArea": "sample string 3",
            "ActionTypeId": 4,
            "ActionType": "sample string 5",
            "ActionTypeAbbreviation": "sample string 6",
            "DisciplineId": 1,
            "Discipline": "sample string 7",
            "ExcecutiveId": 1,
            "ExcecutiveName": "sample string 8",
            "Remarks": "sample string 9",
            "Status": "sample string 10"
          },
          {
            "$ref": "4"
          }
        ],
        "OmahaDomainId": 9
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientplanOmahaDomain xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanOmahaDomain>
    <Areas>
      <ClientplanOmahaArea>
        <Area>sample string 3</Area>
        <AreaId>2</AreaId>
        <Id>d7c06414-c7b4-4596-b649-43137d6534c3</Id>
        <Interventions>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
        </Interventions>
        <OmahaDomainId>9</OmahaDomainId>
        <Range>sample string 5</Range>
        <RangeId>4</RangeId>
        <Remarks>sample string 8</Remarks>
        <Symptoms xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Omaha">
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
        </Symptoms>
        <Typification>sample string 7</Typification>
        <TypificationId>6</TypificationId>
      </ClientplanOmahaArea>
      <ClientplanOmahaArea>
        <Area>sample string 3</Area>
        <AreaId>2</AreaId>
        <Id>d7c06414-c7b4-4596-b649-43137d6534c3</Id>
        <Interventions>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
        </Interventions>
        <OmahaDomainId>9</OmahaDomainId>
        <Range>sample string 5</Range>
        <RangeId>4</RangeId>
        <Remarks>sample string 8</Remarks>
        <Symptoms xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Omaha">
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
        </Symptoms>
        <Typification>sample string 7</Typification>
        <TypificationId>6</TypificationId>
      </ClientplanOmahaArea>
    </Areas>
    <Id>1</Id>
    <Index>3</Index>
    <Name>sample string 2</Name>
  </ClientplanOmahaDomain>
  <ClientplanOmahaDomain>
    <Areas>
      <ClientplanOmahaArea>
        <Area>sample string 3</Area>
        <AreaId>2</AreaId>
        <Id>d7c06414-c7b4-4596-b649-43137d6534c3</Id>
        <Interventions>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
        </Interventions>
        <OmahaDomainId>9</OmahaDomainId>
        <Range>sample string 5</Range>
        <RangeId>4</RangeId>
        <Remarks>sample string 8</Remarks>
        <Symptoms xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Omaha">
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
        </Symptoms>
        <Typification>sample string 7</Typification>
        <TypificationId>6</TypificationId>
      </ClientplanOmahaArea>
      <ClientplanOmahaArea>
        <Area>sample string 3</Area>
        <AreaId>2</AreaId>
        <Id>d7c06414-c7b4-4596-b649-43137d6534c3</Id>
        <Interventions>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
          <ClientplanOmahaIntervention>
            <ActionArea>sample string 3</ActionArea>
            <ActionAreaId>2</ActionAreaId>
            <ActionType>sample string 5</ActionType>
            <ActionTypeAbbreviation>sample string 6</ActionTypeAbbreviation>
            <ActionTypeId>4</ActionTypeId>
            <Discipline>sample string 7</Discipline>
            <DisciplineId>1</DisciplineId>
            <ExcecutiveId>1</ExcecutiveId>
            <ExcecutiveName>sample string 8</ExcecutiveName>
            <Id>99edb1df-1eae-4f76-8baa-d59ed9b9b54c</Id>
            <Remarks>sample string 9</Remarks>
            <Status>sample string 10</Status>
          </ClientplanOmahaIntervention>
        </Interventions>
        <OmahaDomainId>9</OmahaDomainId>
        <Range>sample string 5</Range>
        <RangeId>4</RangeId>
        <Remarks>sample string 8</Remarks>
        <Symptoms xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Omaha">
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
          <d5p1:OmahaSymptom>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Term>sample string 2</d5p1:Term>
          </d5p1:OmahaSymptom>
        </Symptoms>
        <Typification>sample string 7</Typification>
        <TypificationId>6</TypificationId>
      </ClientplanOmahaArea>
    </Areas>
    <Id>1</Id>
    <Index>3</Index>
    <Name>sample string 2</Name>
  </ClientplanOmahaDomain>
</ArrayOfClientplanOmahaDomain>