Artifact (Obsolete)

Report artifacts from PI Web

Obsolete

This class is obsolete. Please consider use of Artifact2.

Artifact Definition

FOTO defines an artifact as the metadata associated with an episode

SOAP method

SOAP Discovery

SOAP 1.1
    http://devs.patient-inquiry.com/artifact/soap?wsdl
SOAP 1.2
    http://devs.patient-inquiry.com/artifact/soap12?wsdl

APIEpisodeArtifact[] GetCollection()

Gets a summary of the available reports in the last 30 days

APIEpisodeArtifact[] GetCollectionSinceDate(string changesSinceDate)

Gets a summary of the available reports since the specified date

APIEpisodeArtifact[] GetCollectionByEpisode(string externalId)

Gets a summary of available documents for the provided external episode Id

REST Method

Resource URLs

REST XML
    http://devs.patient-inquiry.com/artifact/ 
REST json
    http://devs.patient-inquiry.com/artifact/json/ 

GET

Gets a summary of available documents in the last 30 days or an optionally specified date

Parameter: Optional - changesSinceDate[]
Response: APIEpisodeArtifact[]

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

Resource URLs

REST XML
    http://devs.patient-inquiry.com/artifact/episode 
REST json
    http://devs.patient-inquiry.com/artifact/json/episode 

GET

Gets a summary of available documents for the provided external episode Id

Parameter: externalId
Response: APIEpisodeArtifact[]

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

Supporting Objects and Structures (order matters when using XML)

  public class APIEpisodeArtifact
  {
    public string ExternalEpisodeId;
    public int EpisodeId;
    public List<FunctionalAssessment> FunctionalAssessments;
    public List<PQRSClaimsReportingCode> PQRSClaimsReportingCodes;
    public int ReportId;
    public PatientReportType ReportType;
    public DateTime SurveyDateTimeCompleted;
    public DateTime SurveyDateTimeStarted;
  }
  public class FunctionalAssessment
  {
    public List<CMSFunctionalLimitation> CMSFunctionalLimitations;
    public string Descriptor;
    public List<FunctionalScoreSummary> FunctionalScoreSummaries;
    public ChangeSummary PredictedChangeSummary;
  }
  public class FunctionalScoreSummary
  {
    public int FunctionalLimitation;
    public int FunctionalScore;
    public string Label;
    public CMSModifier Modifier;
    public PatientReportType ScoreType;
  }
  public class CMSModifier
  {
    public string Descriptior;
    public int Id;
    public int LowerBound;
    public string Modifier;
    public int UpperBound;
  }
  public class CMSFunctionalLimitation
  {
    public int AskedCurrent;
    public int AskedDischarge;
    public string Descriptor;
    public string GcodeCurrent;
    public string GcodeDischarge;
    public string GcodeGoal;
    public int Id;
    public string ShortDescriptor;
    public char Type;
  }
  public class ChangeSummary
  {
    public int PredictedChange;
    public int FunctionalLimitationGoal;
    public int FunctionalScoreGoal;
    public CMSModifier Modifier;
  }
  public class PQRSClaimsReportingCode
  {
    public string Code;
    public string LongDescription;
    public string Modifier;
    public string ShortDescription;
  }
  public enum PatientReportType
  {
    Intake,
    Status,
    Discharge,
    NonParticipation,
    ADLIntake,
    ADLStatus,
    MDT,
    MSIntake,
    MSStatus
  }

Objects Modeled with Relationships

APIEpisodeArtifact Diagram

Structures Explained

The image below is a piece of a patient report. The colored text is markup that indicates how and where the APIEpisodeArtifact data elements are used.

Labeled report section

In order to see this report segment in context please download the full report.

Download Sample Report