View scope

keyword
PIXM
Description
Assertions from volume 1 and 2
Back

27 Assertions in Scope

Search Criteria

Id scheme
Assertion id
Predicate
ITI83ITI83-001Given that the parameters are not complex types, the HTTP GET operation shall be used as defined in FHIR (http://hl7.org/fhir/operations.html#request).
ITI83ITI83-002The name of the operation is $ihe-pix, and it is applied to FHIR Patient Resource type.
ITI83ITI83-003The Get Corresponding Identifiers message is conducted by the Patient Identifier Crossreference Consumer by executing an HTTP GET against the Patient Identifier Cross-reference Manager’s Patient Resource URL.
ITI83ITI83-004The URL for this operation is: [base]/Patient/$ihe-pix where [base] is the URL of Patient Identifier Cross-reference Manager Service provider
ITI83ITI83-005The required HTTP query parameter sourceIdentifier is a token that specifies an identifier associated with the patient whose information is being queried (e.g., a local identifier, account identifier, etc.).
ITI83ITI83-006Both the Patient Identity Domain (i.e., Assigning Authority) and the identifier value, separated by a "|" elements of the sourceIdentifier query parameter shall be valued.
ITI83ITI83-007The Patient Identifier Cross-reference Consumer shall provide exactly one (1) instance of the sourceIdentifier parameter in the query.
ITI83ITI83-008If the Patient Identifier Cross-reference Consumer wishes to select the Patient Identity Domain(s) from to receive Patient Identifiers, it does so by populating the targetSystem parameter (type: uri) with as many domains for which it wants to receive Patient Identifiers.
ITI83ITI83-009When the targetSystem parameter is present, the Patient Identifier Crossreference Manager shall return the Patient Identifiers for each requested domain if a value is known.
ITI83ITI83-010The Patient Identifier Cross-reference Manager shall use the sourceIdentifier and the targetSystem(s) to determine the Patient Identities that match, where Patient Identities include business Identifier(s) and FHIR Patient Resource(s).
ITI83ITI83-011On Failure, the response message is an HTTP status code of 4xx or 5xx indicates an error, and an OperationOutcome Resource shall be returned with details. See specific failure modes in Sections 3.83.4.2.2.2 through 3.83.4.2.2.4.
ITI83ITI83-012On Success, the response message is an HTTP status code of 200 with a single Parameters Resource as shown in Table 3.83.4.2.2-1.
ITI83ITI83-013For each matching business Identifier, the Parameters Resource shall include one parameter element with name="targetIdentifier", of type Identifier.
ITI83ITI83-014For each matching Patient Resource, the Parameters Resource shall include one parameter element with name="targetId" of type Reference(Patient).
ITI83ITI83-015Within the response, the targetIdentifier and targetId values may be returned in any order.
ITI83ITI83-016The identifier value given in the sourceIdentifier parameter in the query shall not be included in the returned Response.
ITI83ITI83-017The targetIdentifier parameter shall include the assigning authority as specified in ITI TF-2x: Appendix E.3
ITI83ITI83-018When the Patient Identifier Cross-reference Manager recognizes the Patient Identity Domain in the sourceIdentifier but the identifier is not found, then the following failure shall be returned: - HTTP 404 (Not Found) - An OperationOutcome ressource is returned indicating that the patient identifier is not recognized in a issue having: * severity = error * code: http://hl7.org/fhir/R4/codesystem-issue-type.html#not-found * diagnotics : “sourceIdentifier Patient Identifier not found”
ITI83ITI83-019When the Patient Identifier Cross-reference Manager does not recognize the Patient Identity Domain in the sourceIdentifier, then the following failure shall be returned: - HTTP 400 (Bad request) - An OperationOutcome resource is returned indicating that the Patient AssigningAuthority domain is not recognized in an issue having: * severity: error * code: http://hl7.org/fhir/issue-type#code-invalid * diagnostics: “sourceIdentifier Assigning Authority not found”
ITI83ITI83-020When the Patient Identifier Cross-reference Manager does not recognize the Patient Identity Domain in the targetSystem, then the following failure shall be returned: - HTTP 403 (Forbidden) - An OperationOutcome Resource is returned indicating that the Patient Identity Domain is not recognized in an issue having: * severity: error * code: http://hl7.org/fhir/issue-type#code-invalid * diagnostics: “targetSystem not found”