POST Clients/Diagnosis/InitializeNote

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientDiagnosisID	integer	None.
ClientID	integer	None.
DiagnosisID	integer	None.
DiagnosisCode	string	None.
DiagnosisDescription	string	None.
DiagnosisFullDescription	string	None.
DiagnosisDate	date	None.
ResolutionDate	date	None.
OnsetType	ClientDiagnosisOnsetType	None.
Severity	string	None.
IsSignificant	boolean	None.
Comments	string	None.
Sources	Collection of ClientDiagnosisSourceDTO	None.
Props	Collection of Object	None.
RecordState	ClinicalRecordState	None.
SortOrder	integer	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
DiagnosesTableID	integer	None.
DiagnosisTableName	string	None.
DiagnosisReference	string	None.

Request Formats

application/json, text/json

Sample:

{
  "clientDiagnosisID": 1,
  "clientID": 2,
  "diagnosisID": 3,
  "diagnosisCode": "sample string 4",
  "diagnosisDescription": "sample string 5",
  "diagnosisFullDescription": "sample string 6",
  "diagnosisDate": "2024-12-04T07:58:52.1442917+00:00",
  "resolutionDate": "2024-12-04T07:58:52.1442917+00:00",
  "onsetType": 1,
  "severity": "sample string 7",
  "isSignificant": true,
  "comments": "sample string 9",
  "sources": [
    {
      "clientDiagnosisID": 1,
      "sourceEntryID": 2,
      "sourceDate": "2024-12-04T07:58:52.1442917+00:00",
      "sourceStatus": 1,
      "contactID": 1,
      "comments": "sample string 4",
      "recordState": 1,
      "createdByUserID": 5,
      "lastUpdatedByUserID": 6,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1442917+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1442917+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "sourceValue": "sample string 7",
      "summary": "sample string 7"
    },
    {
      "clientDiagnosisID": 1,
      "sourceEntryID": 2,
      "sourceDate": "2024-12-04T07:58:52.1442917+00:00",
      "sourceStatus": 1,
      "contactID": 1,
      "comments": "sample string 4",
      "recordState": 1,
      "createdByUserID": 5,
      "lastUpdatedByUserID": 6,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1442917+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1442917+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "sourceValue": "sample string 7",
      "summary": "sample string 7"
    }
  ],
  "recordState": 1,
  "sortOrder": 10,
  "createdByUserID": 11,
  "lastUpdatedByUserID": 12,
  "created": {
    "dateUtc": "2024-12-04T07:58:52.1442917+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:58:52.1442917+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
  },
  "diagnosesTableID": 13,
  "diagnosisTableName": "sample string 14",
  "diagnosisReference": "sample string 15"
}

application/xml, text/xml

Sample:

<ClientDiagnosisDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ClientDiagnosisID>1</ClientDiagnosisID>
  <ClientID>2</ClientID>
  <Comments>sample string 9</Comments>
  <Created>
    <DateUtc>2024-12-04T07:58:52.1442917+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>11</CreatedByUserID>
  <DiagnosesTableID>13</DiagnosesTableID>
  <DiagnosisCode>sample string 4</DiagnosisCode>
  <DiagnosisDate>2024-12-04T07:58:52.1442917+00:00</DiagnosisDate>
  <DiagnosisDescription>sample string 5</DiagnosisDescription>
  <DiagnosisFullDescription>sample string 6</DiagnosisFullDescription>
  <DiagnosisID>3</DiagnosisID>
  <DiagnosisReference>sample string 15</DiagnosisReference>
  <DiagnosisTableName>sample string 14</DiagnosisTableName>
  <IsSignificant>true</IsSignificant>
  <LastUpdated>
    <DateUtc>2024-12-04T07:58:52.1442917+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>12</LastUpdatedByUserID>
  <OnsetType>Onset</OnsetType>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
  <RecordState>Active</RecordState>
  <ResolutionDate>2024-12-04T07:58:52.1442917+00:00</ResolutionDate>
  <Severity>sample string 7</Severity>
  <SortOrder>10</SortOrder>
  <Sources>
    <ClientDiagnosisSourceDTO>
      <ClientDiagnosisID>1</ClientDiagnosisID>
      <Comments>sample string 4</Comments>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T07:58:52.1442917+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>5</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:52.1442917+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>6</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
      <SourceDate>2024-12-04T07:58:52.1442917+00:00</SourceDate>
      <SourceEntryID>2</SourceEntryID>
      <SourceStatus>Unknown</SourceStatus>
      <SourceValue>sample string 7</SourceValue>
    </ClientDiagnosisSourceDTO>
    <ClientDiagnosisSourceDTO>
      <ClientDiagnosisID>1</ClientDiagnosisID>
      <Comments>sample string 4</Comments>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T07:58:52.1442917+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>5</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:52.1442917+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>6</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
      <SourceDate>2024-12-04T07:58:52.1442917+00:00</SourceDate>
      <SourceEntryID>2</SourceEntryID>
      <SourceStatus>Unknown</SourceStatus>
      <SourceValue>sample string 7</SourceValue>
    </ClientDiagnosisSourceDTO>
  </Sources>
</ClientDiagnosisDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��U�N�0���+-�M��l@Ab$ڲ �\+K��RT���$~�	(Q�������=��;�ߟ_k��N[Ie������l������Fŀ"dX�%���\y>j �`��Jv�Ax�'�>��l�.��:���Qp��>����c��`T���G��4`�E�Y�-lѩ)tPafb%�Rp&-����MO����0&�aT�9��׾�W�[iuQ;Pe��"�,���U�2n��+�ߎ�+�ܪ����ba@��%��E���?,�֨�\X~`���xdiw�h�M��Lw
����#T>�����ڴJ��T���${DCG>-�iQY���'Fi��c�.�;,"��#BO&��SE`��=����6��E���a	$߁����_�

Response Information

Resource Description

NoteDTO

Name	Type	Additional information
NoteID	integer	None.
NoteDateUtc	date	None.
Subject	string	None.
Contents	string	None.
IsDraft	boolean	None.
CustomStatus	string	None.
RecordState	ClinicalRecordState	None.
RecordStateReason	string	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Entities	Collection of EntityNoteDTO	None.
Extensions	Collection of FormDataExtensionDto	None.
NoteTypes	Collection of NoteNoteTypeDTO	None.
FollowUpRequired	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "noteID": 1,
  "noteDateUtc": "2024-12-04T07:58:52.1605297+00:00",
  "subject": "sample string 3",
  "contents": "sample string 4",
  "isDraft": true,
  "customStatus": "sample string 6",
  "recordState": 1,
  "recordStateReason": "sample string 7",
  "createdByUserID": 8,
  "lastUpdatedByUserID": 9,
  "created": {
    "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
  },
  "entities": [
    {
      "entityID": 1,
      "entityType": 1,
      "noteID": 2,
      "noteTypeID": 3,
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      }
    },
    {
      "entityID": 1,
      "entityType": 1,
      "noteID": 2,
      "noteTypeID": 3,
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      }
    }
  ],
  "extensions": [
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2"
      }
    },
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2"
      }
    }
  ],
  "noteTypes": [
    {
      "noteID": 1,
      "noteTypeID": 2,
      "noteTypeName": "sample string 3",
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      }
    },
    {
      "noteID": 1,
      "noteTypeID": 2,
      "noteTypeName": "sample string 3",
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:52.1605297+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:52 AM"
      }
    }
  ],
  "followUpRequired": true
}

application/xml, text/xml

Sample:

<NoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <Contents>sample string 4</Contents>
  <Created>
    <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>8</CreatedByUserID>
  <CustomStatus>sample string 6</CustomStatus>
  <Entities>
    <EntityNoteDTO>
      <Created>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <EntityID>1</EntityID>
      <EntityType>Organization</EntityType>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>5</LastUpdatedByUserID>
      <NoteID>2</NoteID>
      <NoteTypeID>3</NoteTypeID>
      <RecordState>Active</RecordState>
    </EntityNoteDTO>
    <EntityNoteDTO>
      <Created>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <EntityID>1</EntityID>
      <EntityType>Organization</EntityType>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>5</LastUpdatedByUserID>
      <NoteID>2</NoteID>
      <NoteTypeID>3</NoteTypeID>
      <RecordState>Active</RecordState>
    </EntityNoteDTO>
  </Entities>
  <Extensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T07:58:52.1605297+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T07:58:52.1605297+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T07:58:52.1605297+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T07:58:52.1605297+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
  </Extensions>
  <FollowUpRequired>true</FollowUpRequired>
  <IsDraft>true</IsDraft>
  <LastUpdated>
    <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>9</LastUpdatedByUserID>
  <NoteDateUtc>2024-12-04T07:58:52.1605297+00:00</NoteDateUtc>
  <NoteID>1</NoteID>
  <NoteTypes>
    <NoteNoteTypeDTO>
      <Created>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>5</LastUpdatedByUserID>
      <NoteID>1</NoteID>
      <NoteTypeID>2</NoteTypeID>
      <NoteTypeName>sample string 3</NoteTypeName>
      <RecordState>Active</RecordState>
    </NoteNoteTypeDTO>
    <NoteNoteTypeDTO>
      <Created>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:52.1605297+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>5</LastUpdatedByUserID>
      <NoteID>1</NoteID>
      <NoteTypeID>2</NoteTypeID>
      <NoteTypeName>sample string 3</NoteTypeName>
      <RecordState>Active</RecordState>
    </NoteNoteTypeDTO>
  </NoteTypes>
  <RecordState>Active</RecordState>
  <RecordStateReason>sample string 7</RecordStateReason>
  <Subject>sample string 3</Subject>
</NoteDTO>

application/x-compressed-json

Sample:

���N�0�_��V�J�Ý��,Q/�vevQ�̠�b[�dٓy�#�
�0�&��d&�ᮧ�k��_O����1�` ߱�f@�T�|D0q;�`w��7�=r��GF��}���d~���jI�,K*�{��s!g
�������]�J䠵�T<�QT�u}_��\DF�խxTrV50hAt^�$�ȡ�*�,�v�G-�(���z�k�B�)7(M�(�9�3�!]�k>a��ή�j��1��c�s���b}`�`Zd�9?&C���7a����m�`����јk/�1g��2H	d�EzC]���g*]��Z�y��K��V���k�Yt[5�w�ޞ'����ܑ-��B27wA���Y6��<ƕ�
\}��ܐ