GET CarePlans/CarePlanItemImage

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeActive

boolean

None.

IncludeInactive

boolean

None.

IncludeDeleted

boolean

None.

Match

MatchCriteriaStringType

None.

CarePlanItemFileIDs

Collection of integer

None.

CarePlanItemID

integer

None.

FileTypeID

integer

None.

BinaryID

integer

None.

Description

string

None.

FileName

string

None.

FileExtension

string

None.

FileSize

integer

None.

FileDateUtcMin

date

None.

FileDateUtcMax

date

None.

Props

Collection of Object

None.

Comments

string

None.

CreatedDateUtcMin

date

None.

CreatedDateUtcMax

date

None.

LastUpdatedDateUtcMin

date

None.

LastUpdatedDateUtcMax

date

None.

IncludePayload

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CarePlanItemFileDTO
NameDescriptionTypeAdditional information
CarePlanItemFileID

integer

None.

CarePlanItemFileKey

string

None.

CarePlanItemID

integer

None.

FileTypeID

integer

None.

FileTypeName

string

None.

BinaryID

integer

None.

Description

string

None.

FileName

string

None.

FileExtension

string

None.

FileSize

integer

None.

FileDateUtc

date

None.

Props

Collection of Object

None.

Comments

string

None.

Data

string

None.

DataCompressionType

CompressionType

None.

DataProps

Collection of Object

None.

RecordState

ClinicalRecordState

None.

Created

AuditDataDTO

None.

LastUpdated

AuditDataDTO

None.

Summary

string

None.

Response Formats

application/json, text/json

Sample:
[
  null,
  {
    "carePlanItemFileID": 1,
    "carePlanItemFileKey": "sample string 2",
    "carePlanItemID": 3,
    "fileTypeID": 4,
    "fileTypeName": "sample string 5",
    "binaryID": 6,
    "description": "sample string 7",
    "fileName": "sample string 8",
    "fileExtension": "sample string 9",
    "fileSize": 10,
    "fileDateUtc": "2024-12-04T07:50:36.0379596+00:00",
    "comments": "sample string 12",
    "data": "",
    "recordState": 1,
    "created": {
      "dateUtc": "0001-01-01T00:00:00Z",
      "summary": "Unknown on TBD"
    },
    "lastUpdated": {
      "dateUtc": "0001-01-01T00:00:00Z",
      "summary": "Unknown on TBD"
    },
    "summary": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCarePlanItemFileDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <CarePlanItemFileDTO i:nil="true" />
  <CarePlanItemFileDTO>
    <BinaryID>6</BinaryID>
    <CarePlanItemFileID>1</CarePlanItemFileID>
    <CarePlanItemFileKey>sample string 2</CarePlanItemFileKey>
    <CarePlanItemID>3</CarePlanItemID>
    <Comments>sample string 12</Comments>
    <Created>
      <DateUtc>0001-01-01T00:00:00Z</DateUtc>
      <UserName i:nil="true" />
    </Created>
    <Data xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO">
      <__identity i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/System" />
      <d3p1:_buffer />
      <d3p1:_capacity>0</d3p1:_capacity>
      <d3p1:_expandable>true</d3p1:_expandable>
      <d3p1:_exposable>true</d3p1:_exposable>
      <d3p1:_isOpen>true</d3p1:_isOpen>
      <d3p1:_length>0</d3p1:_length>
      <d3p1:_origin>0</d3p1:_origin>
      <d3p1:_position>0</d3p1:_position>
      <d3p1:_writable>true</d3p1:_writable>
    </Data>
    <DataAsString></DataAsString>
    <DataCompressionType i:nil="true" />
    <DataProps xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <Description>sample string 7</Description>
    <FileDateUtc>2024-12-04T07:50:36.0379596+00:00</FileDateUtc>
    <FileExtension>sample string 9</FileExtension>
    <FileName>sample string 8</FileName>
    <FileSize>10</FileSize>
    <FileTypeID>4</FileTypeID>
    <FileTypeName>sample string 5</FileTypeName>
    <LastUpdated>
      <DateUtc>0001-01-01T00:00:00Z</DateUtc>
      <UserName i:nil="true" />
    </LastUpdated>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
  </CarePlanItemFileDTO>
</ArrayOfCarePlanItemFileDTO>

application/x-compressed-json

Sample:
����J�0�_��j+�o��TaD���x��(�$-I��>��W0��E�Ga��o~!��ϯ��ߓ�i�Lm,�k.pS���%��^�g���ŋ�on\�}���j�'Sr<�2�+E�O\1=�t�M�yoy�VpNf�I��2�z��̩�b!��í�0�Jf����#�� �H*�i
4��!΋���(���NJT֬��F�,s�il:�n���qjtmK�~�� ��&��{�kvR�@P�Wս)�S^uY��O3���qg�<<��X!