Artifact Examples (Obsolete)

Examples of using the API

Obsolete

This class is obsolete. Please consider use of Artifact2.

REST samples

These following REST examples were all run via Fiddler. For more information on Fiddler and SOAP samples please refer to our Samples page.


JSON GET

http://devs.patient-inquiry.com/artifact/json/?Api-Key=a8e09fcb-76d4-4912-be4c-6ed3bcd1e93a

JSON GET (By Since Date)

http://devs.patient-inquiry.com/artifact/json/01-31-2013?Api-Key=a8e09fcb-76d4-4912-be4c-6ed3bcd1e93a

JSON GET (By Episode)

http://devs.patient-inquiry.com/artifact/json/episode/ExternalId?Api-Key=a8e09fcb-76d4-4912-be4c-6ed3bcd1e93a

Response

    [{
      "EpisodeId":1091,
      "ExternalEpisodeId":"ExternalId",
      "FunctionalAssessments":
      [{
        "CMSFunctionalLimitations": [
        {
          "AskedCurrent":2,
          "AskedDischarge":0,
          "Descriptor":"Mobility: walking & moving around functional limitation",
          "GcodeCurrent":"G8978",
          "GcodeDischarge":"G8980",
          "GcodeGoal":"G8979",
          "Id":1,
          "ShortDescriptor":"Mobility",
          "Type":"\u0000"
        },
        {
          "AskedCurrent":0,
          "AskedDischarge":0,
          "Descriptor":"Changing & maintaining body position functional limitation",
          "GcodeCurrent":"G8981",
          "GcodeDischarge":"G8983",
          "GcodeGoal":"G8982",
          "Id":2,
          "ShortDescriptor":"Changing & Maintaining Body Position",
          "Type":"\u0000"
        },
        {
          "AskedCurrent":0,
          "AskedDischarge":0,
          "Descriptor":"Carrying, moving & handling objects functional limitation",
          "GcodeCurrent":"G8984",
          "GcodeDischarge":"G8986",
          "GcodeGoal":"G8985",
          "Id":3,
          "ShortDescriptor":"Carrying, Moving & Handling Objects",
          "Type":"\u0000"
        },
        {
          "AskedCurrent":1,
          "AskedDischarge":0,
          "Descriptor":"Self care functional limitation",
          "GcodeCurrent":"G8987",
          "GcodeDischarge":"G8989",
          "GcodeGoal":"G8988",
          "Id":4,
          "ShortDescriptor":"Self Care",
          "Type":"\u0000"
        },
        {
          "AskedCurrent":1,
          "AskedDischarge":0,
          "Descriptor":"Other physical or occupational primary functional limitation",
          "GcodeCurrent":"G8990",
          "GcodeDischarge":"G8992",
          "GcodeGoal":"G8991",
          "Id":5,
          "ShortDescriptor":"Other PT\/OT Primary",
          "Type":"\u0000"
        }],
        "Descriptor":null,
        "FunctionalScoreSummaries":
        [{
          "FunctionalLimitation":74,
          "FunctionalScore":26,
          "Label":"Intake",
          "Modifier":
          {
            "Descriptior":"At least 60 percent but less than 80 percent",
            "Id":5,
            "LowerBound":60,
            "Modifier":"CL",
            "UpperBound":80
          },
          "ScoreType":0
        }],
        "PredictedChangeSummary":
        {
          "FunctionalLimitationGoal":45,
          "FunctionalScoreGoal":55,
          "Modifier":
          {
            "Descriptior":"At least 40 percent but less than 60 percent",
            "Id":4,
            "LowerBound":40,
            "Modifier":"CK",
            "UpperBound":60
          },
          "PredictedChange":29
        }
      }],
      "PQRSClaimsReportingCodes":null,
      "ReportId":1484,
      "ReportType":0,
      "SurveyDateTimeCompleted":"\/Date(1360169509310-0500)\/",
      "SurveyDateTimeStarted":"\/Date(1360169272783-0500)\/"
    }]
  

XML GET

http://devs.patient-inquiry.com/artifact/?Api-Key=a8e09fcb-76d4-4912-be4c-6ed3bcd1e93a

XML GET (By Since Date)

http://devs.patient-inquiry.com/artifact/2013-01-31?Api-Key=a8e09fcb-76d4-4912-be4c-6ed3bcd1e93a

XML GET (By Episode)

http://devs.patient-inquiry.com/artifact/episode/ExternalId?Api-Key=a8e09fcb-76d4-4912-be4c-6ed3bcd1e93a

Response

    <ArrayOfAPIEpisodeArtifact xmlns="http://schemas.datacontract.org/2004/07/PI.Domain" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <APIEpisodeArtifact>
        <EpisodeId>1091</EpisodeId>
        <ExternalEpisodeId>ExternalId</ExternalEpisodeId>
        <FunctionalAssessments>
          <FunctionalAssessment>
            <CMSFunctionalLimitations>
              <CMSFunctionalLimitation>
                <AskedCurrent>2</AskedCurrent>
                <AskedDischarge>0</AskedDischarge>
                <Descriptor>Mobility: walking & moving around functional limitation</Descriptor>
                <GcodeCurrent>G8978</GcodeCurrent>
                <GcodeDischarge>G8980</GcodeDischarge>
                <GcodeGoal>G8979</GcodeGoal>
                <GcodeSet i:nil="true"/>
                <Id>1</Id>
                <ShortDescriptor>Mobility</ShortDescriptor>
                <Type>0</Type>
              </CMSFunctionalLimitation>
              <CMSFunctionalLimitation>
                <AskedCurrent>0</AskedCurrent>
                <AskedDischarge>0</AskedDischarge>
                <Descriptor>Changing & maintaining body position functional limitation</Descriptor>
                <GcodeCurrent>G8981</GcodeCurrent>
                <GcodeDischarge>G8983</GcodeDischarge>
                <GcodeGoal>G8982</GcodeGoal>
                <GcodeSet i:nil="true"/>
                <Id>2</Id>
                <ShortDescriptor>Changing & Maintaining Body Position</ShortDescriptor>
                <Type>0</Type>
              </CMSFunctionalLimitation>
              <CMSFunctionalLimitation>
                <AskedCurrent>0</AskedCurrent>
                <AskedDischarge>0</AskedDischarge>
                <Descriptor>Carrying, moving & handling objects functional limitation</Descriptor>
                <GcodeCurrent>G8984</GcodeCurrent>
                <GcodeDischarge>G8986</GcodeDischarge>
                <GcodeGoal>G8985</GcodeGoal>
                <GcodeSet i:nil="true"/>
                <Id>3</Id>
                <ShortDescriptor>Carrying, Moving & Handling Objects</ShortDescriptor>
                <Type>0</Type>
              </CMSFunctionalLimitation>
              <CMSFunctionalLimitation>
                <AskedCurrent>1</AskedCurrent>
                <AskedDischarge>0</AskedDischarge>
                <Descriptor>Self care functional limitation</Descriptor>
                <GcodeCurrent>G8987</GcodeCurrent>
                <GcodeDischarge>G8989</GcodeDischarge>
                <GcodeGoal>G8988</GcodeGoal>
                <GcodeSet i:nil="true"/>
                <Id>4</Id>
                <ShortDescriptor>Self Care</ShortDescriptor>
                <Type>0</Type>
              </CMSFunctionalLimitation>
              <CMSFunctionalLimitation>
                <AskedCurrent>1</AskedCurrent>
                <AskedDischarge>0</AskedDischarge>
                <Descriptor>Other physical or occupational primary functional limitation</Descriptor>
                <GcodeCurrent>G8990</GcodeCurrent>
                <GcodeDischarge>G8992</GcodeDischarge>
                <GcodeGoal>G8991</GcodeGoal>
                <GcodeSet i:nil="true"/>
                <Id>5</Id>
                <ShortDescriptor>Other PT/OT Primary</ShortDescriptor>
                <Type>0</Type>
              </CMSFunctionalLimitation>
            </CMSFunctionalLimitations>
            <Descriptor i:nil="true"/>
            <FunctionalScoreSummaries>
              <FunctionalScoreSummary>
                <FunctionalLimitation>74</FunctionalLimitation>
                <FunctionalScore>26</FunctionalScore>
                <Label>Intake</Label>
                <Modifier>
                  <Descriptior>At least 60 percent but less than 80 percent</Descriptior>
                  <Id>5</Id>
                  <LowerBound>60</LowerBound>
                  <Modifier>CL</Modifier>
                  <UpperBound>80</UpperBound>
                </Modifier>
                <ScoreType>Intake</ScoreType>
              </FunctionalScoreSummary>
            </FunctionalScoreSummaries>
            <PredictedChangeSummary>
              <FunctionalLimitationGoal>45</FunctionalLimitationGoal>
              <FunctionalScoreGoal>55</FunctionalScoreGoal>
              <Modifier>
                <Descriptior>At least 40 percent but less than 60 percent</Descriptior>
                <Id>4</Id>
                <LowerBound>40</LowerBound>
                <Modifier>CK</Modifier>
                <UpperBound>60</UpperBound>
              </Modifier>
              <PredictedChange>29</PredictedChange>
            </PredictedChangeSummary>
          </FunctionalAssessment>
        </FunctionalAssessments>
        <PQRSClaimsReportingCodes i:nil="true"/>
        <ReportId>1484</ReportId>
        <ReportType>Intake</ReportType>
        <SurveyDateTimeCompleted>2013-02-06T11:51:49.31</SurveyDateTimeCompleted>
        <SurveyDateTimeStarted>2013-02-06T11:47:52.783</SurveyDateTimeStarted>
      </APIEpisodeArtifact>
    </ArrayOfAPIEpisodeArtifact>
  

SOAP samples

Here at FOTO we are a Microsoft .Net shop so our SOAP testing application is built as a windows console application in VS2010. Please feel free to download it and use it as jumping off point for your implementation. If you've used web services via WCF before then it should look familiar. The biggest item to pay attention to is the CustomMessageInspector.cs which is responsible for injecting the API Key into the header.

Download SOAP Testing Client