STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Patient-mpi-search.ttl

Raw Turtle, JSON-LD

Patient MPI Query

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/patient-mpi> a fhir:OperationDefinition;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "patient-mpi"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: patient-mpi</p><p><b>url</b>: <a>http://hl7.org/fhir/OperationDefinitino/patient-mpi</a></p><p><b>name</b>: Patient MPI (Multiple Patient Index) search</p><p><b>status</b>: draft</p><p><b>kind</b>: query</p><p><b>experimental</b>: false</p><p><b>date</b>: 18/08/2015</p><p><b>publisher</b>: HL7, Inc</p><p><b>contact</b>: </p><p><b>description</b>: An MPI search differs from a normal search because the parameters are interpreted as inputs to an MPI match process, rather than as direct match criteria on the returned resources</p><p><b>purpose</b>: This query is defined to allow an MPI to be integrated in a FHIR server environment, and to allow a client to delegate the matching process to a specialist. MPI algorithms are often highly tailored to a particular patient set</p><p><b>idempotent</b>: true</p><p><b>code</b>: mpi</p><p><b>comment</b>: All the standard search parameters apply, and are interpreted as inputs to the MPI algorithm. The _sort parameter is not used. Matches are returned in order of highest match to lowest match, with both a % in the score, and an asessement of the match using the extension http://hl7.org/fhir/StructureDefinition/patient-mpi-match</p><p><b>resource</b>: Patient</p><p><b>system</b>: false</p><p><b>type</b>: true</p><p><b>instance</b>: false</p><blockquote><p><b>parameter</b></p><p><b>name</b>: userid</p><p><b>use</b>: in</p><p><b>min</b>: 0</p><p><b>max</b>: 1</p><p><b>documentation</b>: User identity for the MPI to consider when creating a return set. This paraemter is defined in the assumption that the MPI ay be a separate module from other FHIR Servers, with a trust relationship to it. Actualy deployment scenarios will determine whether this parameter is used</p><p><b>type</b>: string</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: result</p><p><b>use</b>: out</p><p><b>min</b>: 0</p><p><b>max</b>: *</p><p><b>documentation</b>: Patients that match this MPI query</p><p><b>type</b>: Patient</p></blockquote></div>"
  ];
  fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinitino/patient-mpi"];
  fhir:OperationDefinition.name [ fhir:value "Patient MPI (Multiple Patient Index) search"];
  fhir:OperationDefinition.status [ fhir:value "draft"];
  fhir:OperationDefinition.kind [ fhir:value "query"];
  fhir:OperationDefinition.experimental [ fhir:value "false"^^xsd:boolean];
  fhir:OperationDefinition.date [ fhir:value "2015-08-18"^^xsd:date];
  fhir:OperationDefinition.publisher [ fhir:value "HL7, Inc"];
  fhir:OperationDefinition.contact [
     fhir:index 0;
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ]
  ];
  fhir:OperationDefinition.description [ fhir:value "An MPI search differs from a normal search because the parameters are interpreted as inputs to an MPI match process, rather than as direct match criteria on the returned resources"];
  fhir:OperationDefinition.purpose [ fhir:value "This query is defined to allow an MPI to be integrated in a FHIR server environment, and to allow a client to delegate the matching process to a specialist. MPI algorithms are often highly tailored to a particular patient set"];
  fhir:OperationDefinition.idempotent [ fhir:value "true"^^xsd:boolean];
  fhir:OperationDefinition.code [ fhir:value "mpi"];
  fhir:OperationDefinition.comment [ fhir:value "All the standard search parameters apply, and are interpreted as inputs to the MPI algorithm. The _sort parameter is not used. Matches are returned in order of highest match to lowest match, with both a % in the score, and an asessement of the match using the extension http://hl7.org/fhir/StructureDefinition/patient-mpi-match"];
  fhir:OperationDefinition.resource [
     fhir:value "Patient";
     fhir:index 0
  ];
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean];
  fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean];
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean];
  fhir:OperationDefinition.parameter [
     fhir:index 0;
     fhir:OperationDefinition.parameter.name [ fhir:value "userid" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:int ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir:value "User identity for the MPI to consider when creating a return set. This paraemter is defined in the assumption that the MPI ay be a separate module from other FHIR Servers, with a trust relationship to it. Actualy deployment scenarios will determine whether this parameter is used" ];
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
  ], [
     fhir:index 1;
     fhir:OperationDefinition.parameter.name [ fhir:value "result" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:int ];
     fhir:OperationDefinition.parameter.max [ fhir:value "*" ];
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Patients that match this MPI query" ];
     fhir:OperationDefinition.parameter.type [ fhir:value "Patient" ]
  ] .

# -------------------------------------------------------------------------------------


Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.