GET api/Imaging/GetEntireImaging/{accessKey}
Retrieves the entire published Imaging compendia. Please note this is a large dataset so please limit your calls to this endpoint
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accessKey | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ImagingRequestName | Description | Type | Additional information |
---|---|---|---|
IsValid | boolean |
None. |
|
Message | string |
None. |
|
GuidelineRecords |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsValid": true, "Message": "sample string 2", "GuidelineRecords": [ { "GuidelineId": 1, "Name": "sample string 2", "PublishDate": "2024-11-23T18:00:00.5640766-05:00", "VersionNumber": "sample string 3", "ImagingRecords": [ { "ImagingId": 1, "DataChanged": true, "DiseaseName": "sample string 3", "AdditionalStaging": "sample string 4", "StagingSystem": "sample string 5", "Indication": "sample string 6", "Recommendation": "sample string 7", "FollowUpInterval": "sample string 8", "Notes": "sample string 9", "Purposes": [ { "PurposeName": "sample string 1" }, { "PurposeName": "sample string 1" } ], "CategoryEvidence": { "EvidenceName": "sample string 1", "Description": "sample string 2" }, "ICD10Codes": [ { "ICD10Code": "sample string 1", "Description": "sample string 2" }, { "ICD10Code": "sample string 1", "Description": "sample string 2" } ], "Histologies": [ { "HistologyName": "sample string 1" }, { "HistologyName": "sample string 1" } ], "Keywords": [ { "KeywordName": "sample string 1" }, { "KeywordName": "sample string 1" } ], "TNMs": [ { "Name": "sample string 1" }, { "Name": "sample string 1" } ], "RationaleForTreatmentTechnique": "sample string 10", "GuidelinePages": [ { "PageName": "sample string 1", "PageNumber": "sample string 2" }, { "PageName": "sample string 1", "PageNumber": "sample string 2" } ], "Stages": [ { "StageName": "sample string 1" }, { "StageName": "sample string 1" } ] }, { "ImagingId": 1, "DataChanged": true, "DiseaseName": "sample string 3", "AdditionalStaging": "sample string 4", "StagingSystem": "sample string 5", "Indication": "sample string 6", "Recommendation": "sample string 7", "FollowUpInterval": "sample string 8", "Notes": "sample string 9", "Purposes": [ { "PurposeName": "sample string 1" }, { "PurposeName": "sample string 1" } ], "CategoryEvidence": { "EvidenceName": "sample string 1", "Description": "sample string 2" }, "ICD10Codes": [ { "ICD10Code": "sample string 1", "Description": "sample string 2" }, { "ICD10Code": "sample string 1", "Description": "sample string 2" } ], "Histologies": [ { "HistologyName": "sample string 1" }, { "HistologyName": "sample string 1" } ], "Keywords": [ { "KeywordName": "sample string 1" }, { "KeywordName": "sample string 1" } ], "TNMs": [ { "Name": "sample string 1" }, { "Name": "sample string 1" } ], "RationaleForTreatmentTechnique": "sample string 10", "GuidelinePages": [ { "PageName": "sample string 1", "PageNumber": "sample string 2" }, { "PageName": "sample string 1", "PageNumber": "sample string 2" } ], "Stages": [ { "StageName": "sample string 1" }, { "StageName": "sample string 1" } ] } ] }, { "GuidelineId": 1, "Name": "sample string 2", "PublishDate": "2024-11-23T18:00:00.5640766-05:00", "VersionNumber": "sample string 3", "ImagingRecords": [ { "ImagingId": 1, "DataChanged": true, "DiseaseName": "sample string 3", "AdditionalStaging": "sample string 4", "StagingSystem": "sample string 5", "Indication": "sample string 6", "Recommendation": "sample string 7", "FollowUpInterval": "sample string 8", "Notes": "sample string 9", "Purposes": [ { "PurposeName": "sample string 1" }, { "PurposeName": "sample string 1" } ], "CategoryEvidence": { "EvidenceName": "sample string 1", "Description": "sample string 2" }, "ICD10Codes": [ { "ICD10Code": "sample string 1", "Description": "sample string 2" }, { "ICD10Code": "sample string 1", "Description": "sample string 2" } ], "Histologies": [ { "HistologyName": "sample string 1" }, { "HistologyName": "sample string 1" } ], "Keywords": [ { "KeywordName": "sample string 1" }, { "KeywordName": "sample string 1" } ], "TNMs": [ { "Name": "sample string 1" }, { "Name": "sample string 1" } ], "RationaleForTreatmentTechnique": "sample string 10", "GuidelinePages": [ { "PageName": "sample string 1", "PageNumber": "sample string 2" }, { "PageName": "sample string 1", "PageNumber": "sample string 2" } ], "Stages": [ { "StageName": "sample string 1" }, { "StageName": "sample string 1" } ] }, { "ImagingId": 1, "DataChanged": true, "DiseaseName": "sample string 3", "AdditionalStaging": "sample string 4", "StagingSystem": "sample string 5", "Indication": "sample string 6", "Recommendation": "sample string 7", "FollowUpInterval": "sample string 8", "Notes": "sample string 9", "Purposes": [ { "PurposeName": "sample string 1" }, { "PurposeName": "sample string 1" } ], "CategoryEvidence": { "EvidenceName": "sample string 1", "Description": "sample string 2" }, "ICD10Codes": [ { "ICD10Code": "sample string 1", "Description": "sample string 2" }, { "ICD10Code": "sample string 1", "Description": "sample string 2" } ], "Histologies": [ { "HistologyName": "sample string 1" }, { "HistologyName": "sample string 1" } ], "Keywords": [ { "KeywordName": "sample string 1" }, { "KeywordName": "sample string 1" } ], "TNMs": [ { "Name": "sample string 1" }, { "Name": "sample string 1" } ], "RationaleForTreatmentTechnique": "sample string 10", "GuidelinePages": [ { "PageName": "sample string 1", "PageNumber": "sample string 2" }, { "PageName": "sample string 1", "PageNumber": "sample string 2" } ], "Stages": [ { "StageName": "sample string 1" }, { "StageName": "sample string 1" } ] } ] } ] }
application/xml, text/xml
Sample:
<ImagingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCCN.Webservice.Compendia.Models"> <GuidelineRecords> <Guideline> <GuidelineId>1</GuidelineId> <ImagingRecords> <Imaging> <AdditionalStaging>sample string 4</AdditionalStaging> <CategoryEvidence> <Description>sample string 2</Description> <EvidenceName>sample string 1</EvidenceName> </CategoryEvidence> <DataChanged>true</DataChanged> <DiseaseName>sample string 3</DiseaseName> <FollowUpInterval>sample string 8</FollowUpInterval> <GuidelinePages> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> </GuidelinePages> <Histologies> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> </Histologies> <ICD10Codes> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> </ICD10Codes> <ImagingId>1</ImagingId> <Indication>sample string 6</Indication> <Keywords> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> </Keywords> <Notes>sample string 9</Notes> <Purposes> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> </Purposes> <RationaleForTreatmentTechnique>sample string 10</RationaleForTreatmentTechnique> <Recommendation>sample string 7</Recommendation> <Stages> <Stage> <StageName>sample string 1</StageName> </Stage> <Stage> <StageName>sample string 1</StageName> </Stage> </Stages> <StagingSystem>sample string 5</StagingSystem> <TNMs> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> </TNMs> </Imaging> <Imaging> <AdditionalStaging>sample string 4</AdditionalStaging> <CategoryEvidence> <Description>sample string 2</Description> <EvidenceName>sample string 1</EvidenceName> </CategoryEvidence> <DataChanged>true</DataChanged> <DiseaseName>sample string 3</DiseaseName> <FollowUpInterval>sample string 8</FollowUpInterval> <GuidelinePages> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> </GuidelinePages> <Histologies> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> </Histologies> <ICD10Codes> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> </ICD10Codes> <ImagingId>1</ImagingId> <Indication>sample string 6</Indication> <Keywords> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> </Keywords> <Notes>sample string 9</Notes> <Purposes> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> </Purposes> <RationaleForTreatmentTechnique>sample string 10</RationaleForTreatmentTechnique> <Recommendation>sample string 7</Recommendation> <Stages> <Stage> <StageName>sample string 1</StageName> </Stage> <Stage> <StageName>sample string 1</StageName> </Stage> </Stages> <StagingSystem>sample string 5</StagingSystem> <TNMs> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> </TNMs> </Imaging> </ImagingRecords> <Name>sample string 2</Name> <PublishDate>2024-11-23T18:00:00.5640766-05:00</PublishDate> <VersionNumber>sample string 3</VersionNumber> </Guideline> <Guideline> <GuidelineId>1</GuidelineId> <ImagingRecords> <Imaging> <AdditionalStaging>sample string 4</AdditionalStaging> <CategoryEvidence> <Description>sample string 2</Description> <EvidenceName>sample string 1</EvidenceName> </CategoryEvidence> <DataChanged>true</DataChanged> <DiseaseName>sample string 3</DiseaseName> <FollowUpInterval>sample string 8</FollowUpInterval> <GuidelinePages> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> </GuidelinePages> <Histologies> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> </Histologies> <ICD10Codes> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> </ICD10Codes> <ImagingId>1</ImagingId> <Indication>sample string 6</Indication> <Keywords> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> </Keywords> <Notes>sample string 9</Notes> <Purposes> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> </Purposes> <RationaleForTreatmentTechnique>sample string 10</RationaleForTreatmentTechnique> <Recommendation>sample string 7</Recommendation> <Stages> <Stage> <StageName>sample string 1</StageName> </Stage> <Stage> <StageName>sample string 1</StageName> </Stage> </Stages> <StagingSystem>sample string 5</StagingSystem> <TNMs> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> </TNMs> </Imaging> <Imaging> <AdditionalStaging>sample string 4</AdditionalStaging> <CategoryEvidence> <Description>sample string 2</Description> <EvidenceName>sample string 1</EvidenceName> </CategoryEvidence> <DataChanged>true</DataChanged> <DiseaseName>sample string 3</DiseaseName> <FollowUpInterval>sample string 8</FollowUpInterval> <GuidelinePages> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> <GuidelinePage> <PageName>sample string 1</PageName> <PageNumber>sample string 2</PageNumber> </GuidelinePage> </GuidelinePages> <Histologies> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> <Histology> <HistologyName>sample string 1</HistologyName> </Histology> </Histologies> <ICD10Codes> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> <ICD10> <Description>sample string 2</Description> <ICD10Code>sample string 1</ICD10Code> </ICD10> </ICD10Codes> <ImagingId>1</ImagingId> <Indication>sample string 6</Indication> <Keywords> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> <Keyword> <KeywordName>sample string 1</KeywordName> </Keyword> </Keywords> <Notes>sample string 9</Notes> <Purposes> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> <Purpose> <PurposeName>sample string 1</PurposeName> </Purpose> </Purposes> <RationaleForTreatmentTechnique>sample string 10</RationaleForTreatmentTechnique> <Recommendation>sample string 7</Recommendation> <Stages> <Stage> <StageName>sample string 1</StageName> </Stage> <Stage> <StageName>sample string 1</StageName> </Stage> </Stages> <StagingSystem>sample string 5</StagingSystem> <TNMs> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> <TumorNodeMetastasis> <Name>sample string 1</Name> </TumorNodeMetastasis> </TNMs> </Imaging> </ImagingRecords> <Name>sample string 2</Name> <PublishDate>2024-11-23T18:00:00.5640766-05:00</PublishDate> <VersionNumber>sample string 3</VersionNumber> </Guideline> </GuidelineRecords> <IsValid>true</IsValid> <Message>sample string 2</Message> </ImagingRequest>