POST Clients/Allergy/InitializeNote

Request Information

URI Parameters

None.

Body Parameters

ClientAllergyDTO
NameDescriptionTypeAdditional information
ClientAllergyID

integer

None.
ClientID

integer

None.
AllergyID

integer

None.
AllergyType

AllergyType

None.
AllergyCode

string

None.
AllergyDescription

string

None.
ReportDate

date

None.
OnsetDate

date

None.
IsOnsetDateEstimated

boolean

None.
Severity

string

None.
Reaction

string

None.
InterventionAfterExposure

string

None.
Comments

string

None.
Sources

Collection of ClientAllergySourceDTO

None.
Props

Collection of Object

None.
RecordState

ClinicalRecordState

None.
CreatedByUserID

integer

None.
LastUpdatedByUserID

integer

None.
Created

AuditDataDTO

None.
LastUpdated

AuditDataDTO

None.

Request Formats

application/json, text/json

Sample: 
{
  "clientAllergyID": 1,
  "clientID": 2,
  "allergyID": 3,
  "allergyType": 1,
  "allergyCode": "sample string 4",
  "allergyDescription": "sample string 5",
  "reportDate": "2024-12-04T07:57:12.3518945+00:00",
  "onsetDate": "2024-12-04T07:57:12.3518945+00:00",
  "isOnsetDateEstimated": true,
  "severity": "sample string 8",
  "reaction": "sample string 9",
  "interventionAfterExposure": "sample string 10",
  "comments": "sample string 11",
  "sources": [
    {
      "clientAllergyID": 1,
      "sourceEntryID": 2,
      "sourceDate": "2024-12-04T07:57:12.3518945+00:00",
      "sourceStatus": 1,
      "contactID": 1,
      "comments": "sample string 4",
      "recordState": 1,
      "createdByUserID": 5,
      "lastUpdatedByUserID": 6,
      "created": {
        "dateUtc": "2024-12-04T07:57:12.3518945+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3518945+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "sourceValue": "sample string 7",
      "summary": "sample string 7"
    },
    {
      "clientAllergyID": 1,
      "sourceEntryID": 2,
      "sourceDate": "2024-12-04T07:57:12.3518945+00:00",
      "sourceStatus": 1,
      "contactID": 1,
      "comments": "sample string 4",
      "recordState": 1,
      "createdByUserID": 5,
      "lastUpdatedByUserID": 6,
      "created": {
        "dateUtc": "2024-12-04T07:57:12.3518945+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3518945+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "sourceValue": "sample string 7",
      "summary": "sample string 7"
    }
  ],
  "recordState": 1,
  "createdByUserID": 12,
  "lastUpdatedByUserID": 13,
  "created": {
    "dateUtc": "2024-12-04T07:57:12.3518945+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:57:12.3518945+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
  }
}

application/xml, text/xml

Sample: 
<ClientAllergyDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <AllergyCode>sample string 4</AllergyCode>
  <AllergyDescription>sample string 5</AllergyDescription>
  <AllergyID>3</AllergyID>
  <AllergyType>Food</AllergyType>
  <ClientAllergyID>1</ClientAllergyID>
  <ClientID>2</ClientID>
  <Comments>sample string 11</Comments>
  <Created>
    <DateUtc>2024-12-04T07:57:12.3518945+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>12</CreatedByUserID>
  <InterventionAfterExposure>sample string 10</InterventionAfterExposure>
  <IsOnsetDateEstimated>true</IsOnsetDateEstimated>
  <LastUpdated>
    <DateUtc>2024-12-04T07:57:12.3518945+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>13</LastUpdatedByUserID>
  <OnsetDate>2024-12-04T07:57:12.3518945+00:00</OnsetDate>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
  <Reaction>sample string 9</Reaction>
  <RecordState>Active</RecordState>
  <ReportDate>2024-12-04T07:57:12.3518945+00:00</ReportDate>
  <Severity>sample string 8</Severity>
  <Sources>
    <ClientAllergySourceDTO>
      <ClientAllergyID>1</ClientAllergyID>
      <Comments>sample string 4</Comments>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T07:57:12.3518945+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>5</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:57:12.3518945+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>6</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
      <SourceDate>2024-12-04T07:57:12.3518945+00:00</SourceDate>
      <SourceEntryID>2</SourceEntryID>
      <SourceStatus>Unknown</SourceStatus>
      <SourceValue>sample string 7</SourceValue>
    </ClientAllergySourceDTO>
    <ClientAllergySourceDTO>
      <ClientAllergyID>1</ClientAllergyID>
      <Comments>sample string 4</Comments>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T07:57:12.3518945+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>5</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:57:12.3518945+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>6</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
      <SourceDate>2024-12-04T07:57:12.3518945+00:00</SourceDate>
      <SourceEntryID>2</SourceEntryID>
      <SourceStatus>Unknown</SourceStatus>
      <SourceValue>sample string 7</SourceValue>
    </ClientAllergySourceDTO>
  </Sources>
</ClientAllergyDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample: 
��R�N�0���+)�nB�l�v`Z�`9���ؑ�RU�2>�_�I����n���w�����sID�I�<�f^ߍIB���
�'��o�i]�5��ou�3��(s�Y0��{!��ci��Jȴ��"�YjcN�,�Q��i'Q�Pvُ�`FA�.he�)��>n6&��)I�T�'V.�ɠ�8��q���Щ*�f�Y!a���R��t��΄�E�d�E)�VWFH_�����n�iNNH�Yx�m��
��6����ڤn�i^`2�M=��8��'9�0+����-�$K���#
W����n���MU�tkc�VeW����j{�{�ڱ��4�<��ƿ�Ƹ|�&�k��5y=���B��V�Y}q�j!@

Response Information

Resource Description

NoteDTO
NameDescriptionTypeAdditional 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:57:12.3675951+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:57:12.3675951+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
  },
  "entities": [
    {
      "entityID": 1,
      "entityType": 1,
      "noteID": 2,
      "noteTypeID": 3,
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      }
    },
    {
      "entityID": 1,
      "entityType": 1,
      "noteID": 2,
      "noteTypeID": 3,
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      }
    }
  ],
  "extensions": [
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2"
      }
    },
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3675951+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:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      }
    },
    {
      "noteID": 1,
      "noteTypeID": 2,
      "noteTypeName": "sample string 3",
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:57:12.3675951+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:57:12 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:57:12.3675951+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>8</CreatedByUserID>
  <CustomStatus>sample string 6</CustomStatus>
  <Entities>
    <EntityNoteDTO>
      <Created>
        <DateUtc>2024-12-04T07:57:12.3675951+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <EntityID>1</EntityID>
      <EntityType>Organization</EntityType>
      <LastUpdated>
        <DateUtc>2024-12-04T07:57:12.3675951+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:57:12.3675951+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <EntityID>1</EntityID>
      <EntityType>Organization</EntityType>
      <LastUpdated>
        <DateUtc>2024-12-04T07:57:12.3675951+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:57:12.3675951+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:57:12.3675951+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:57:12.3675951+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:57:12.3675951+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:57:12.3675951+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>9</LastUpdatedByUserID>
  <NoteDateUtc>2024-12-04T07:57:12.3675951+00:00</NoteDateUtc>
  <NoteID>1</NoteID>
  <NoteTypes>
    <NoteNoteTypeDTO>
      <Created>
        <DateUtc>2024-12-04T07:57:12.3675951+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:57:12.3675951+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:57:12.3675951+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>4</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T07:57:12.3675951+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��p�i���b�+��3S��%˞��W������,������o������%�L�$D�m��0��[��x`�3�<?��3�gYV`Y�D����D*���"CHN��\¨*E+�$!�j��%(m)$˯e,˶~���S-���F<�X0��k� =�"\/��DY,dT����O-
�(���j��8��\oP�Ǽj�F
ݡ�����8�D�-��`GA$��s�l�j}`�`V�y~t7MݯC�������`��̞�ј+������R����`<?'���>�Le�K��]�:��z���j�{M?�n�w���x������#9,$s}d{��)<��kW�7p���P�