GET PlanCare2Api/MedicalDsm5Registration/ActualValue?relationId={relationId}

Gets the actual MedicalDsm5RegistrationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	The id of the relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Actual MedicalDsm5RegistrationSummary.

MedicalDsm5RegistrationSummary

Name	Description	Type	Additional information
Diagnoses	Diagnoses.	Collection of MedicalDsm5DiagnosisSummary	None.
Id	Id of the registration.	integer	None.
RegistrationDateTime	DateTime of measurement.	date	None.
Source	Source of registration (example: name of the questionnaire).	string	None.
ChangedOn	DateTime when registration is last changed (readOnly).	date	None.
ChangedByRelationLookupName	LookupName of the relation who made the change (readOnly).	string	None.
TextValue	The compound value of the registration (readOnly).	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Diagnoses": [
    {
      "$id": "2",
      "Id": 1,
      "MedicalDsm5DiagnosisCodeId": 2,
      "MedicalDsm5DiagnosisCodeDescription": "sample string 3",
      "MedicalDsm5DiagnosisCodeCode": "sample string 4",
      "MedicalDsm5DiagnosisCodeIcd9Code": "sample string 5",
      "MedicalDsm5DiagnosisCodeDateFrom": "2026-05-26T21:03:28.1404195+02:00",
      "MedicalDsm5DiagnosisCodeDateUntil": "2026-05-26T21:03:28.1404195+02:00",
      "Rank": 7,
      "PrimaryDiagnosis": true,
      "Tentative": true,
      "Remarks": "sample string 10"
    },
    {
      "$ref": "2"
    }
  ],
  "Id": 1,
  "RegistrationDateTime": "2026-05-26T21:03:28.1404195+02:00",
  "Source": "sample string 3",
  "ChangedOn": "2026-05-26T21:03:28.1404195+02:00",
  "ChangedByRelationLookupName": "sample string 5",
  "TextValue": "sample string 6"
}

application/xml, text/xml

Sample:

<MedicalDsm5RegistrationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Medical">
  <ChangedByRelationLookupName>sample string 5</ChangedByRelationLookupName>
  <ChangedOn>2026-05-26T21:03:28.1404195+02:00</ChangedOn>
  <Id>1</Id>
  <RegistrationDateTime>2026-05-26T21:03:28.1404195+02:00</RegistrationDateTime>
  <Source>sample string 3</Source>
  <TextValue>sample string 6</TextValue>
  <Diagnoses>
    <MedicalDsm5DiagnosisSummary>
      <Id>1</Id>
      <MedicalDsm5DiagnosisCodeCode>sample string 4</MedicalDsm5DiagnosisCodeCode>
      <MedicalDsm5DiagnosisCodeDateFrom>2026-05-26T21:03:28.1404195+02:00</MedicalDsm5DiagnosisCodeDateFrom>
      <MedicalDsm5DiagnosisCodeDateUntil>2026-05-26T21:03:28.1404195+02:00</MedicalDsm5DiagnosisCodeDateUntil>
      <MedicalDsm5DiagnosisCodeDescription>sample string 3</MedicalDsm5DiagnosisCodeDescription>
      <MedicalDsm5DiagnosisCodeIcd9Code>sample string 5</MedicalDsm5DiagnosisCodeIcd9Code>
      <MedicalDsm5DiagnosisCodeId>2</MedicalDsm5DiagnosisCodeId>
      <PrimaryDiagnosis>true</PrimaryDiagnosis>
      <Rank>7</Rank>
      <Remarks>sample string 10</Remarks>
      <Tentative>true</Tentative>
    </MedicalDsm5DiagnosisSummary>
    <MedicalDsm5DiagnosisSummary>
      <Id>1</Id>
      <MedicalDsm5DiagnosisCodeCode>sample string 4</MedicalDsm5DiagnosisCodeCode>
      <MedicalDsm5DiagnosisCodeDateFrom>2026-05-26T21:03:28.1404195+02:00</MedicalDsm5DiagnosisCodeDateFrom>
      <MedicalDsm5DiagnosisCodeDateUntil>2026-05-26T21:03:28.1404195+02:00</MedicalDsm5DiagnosisCodeDateUntil>
      <MedicalDsm5DiagnosisCodeDescription>sample string 3</MedicalDsm5DiagnosisCodeDescription>
      <MedicalDsm5DiagnosisCodeIcd9Code>sample string 5</MedicalDsm5DiagnosisCodeIcd9Code>
      <MedicalDsm5DiagnosisCodeId>2</MedicalDsm5DiagnosisCodeId>
      <PrimaryDiagnosis>true</PrimaryDiagnosis>
      <Rank>7</Rank>
      <Remarks>sample string 10</Remarks>
      <Tentative>true</Tentative>
    </MedicalDsm5DiagnosisSummary>
  </Diagnoses>
</MedicalDsm5RegistrationSummary>