FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/IHE.PIXm.pix

Packageihe.iti.pixm
TypeOperationDefinition
IdIHE.PIXm.pix
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/PIXm/https://build.fhir.org/ig/IHE/ITI.PIXm/OperationDefinition-IHE.PIXm.pix.html
URLhttps://profiles.ihe.net/ITI/PIXm/OperationDefinition/IHE.PIXm.pix
Version3.0.5-current
Statusactive
Date2022-05-25
NameIHE_PIXm_pix
TitleGet Corresponding Identifiers Operation
Realmuv
Authorityihe
DescriptionThe OperationDefinition defines the In and Output Parameters for the $ihe-pix operation - Input: sourceIdentifier, targetSystem and _format - Output: targetIdentifier, targetId
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition IHE.PIXm.pix

URL: [base]/Patient/$ihe-pix

Input parameters Profile:IHE PIXm Query Parameters In

Output parameters Profile:IHE PIXm Query Parameters Out

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsourceIdentifier1..1string
(token)

The Patient identifier search parameter that will be used by the Patient Identifier Cross-reference Manager to find cross matching identifiers associated with the Patient Resource. See Section 3.83.4.1.2.1.

INtargetSystem0..1string
(uri)

The target Patient Identifier Assigning Authority from which the returned identifiers should be selected. See Section 3.83.4.1.2.2.

IN_format0..1string
(token)

The requested format of the response. See ITI TF-2: Appendix Z.6

OUTtargetIdentifier0..*Identifier

The identifier found. Constraints to include the assigning authority as specified in ITI TF-2: Appendix E.3

OUTtargetId0..*Reference

The URL of the Patient Resource


Source

{
  "resourceType": "OperationDefinition",
  "id": "IHE.PIXm.pix",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 5
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    }
  ],
  "url": "https://profiles.ihe.net/ITI/PIXm/OperationDefinition/IHE.PIXm.pix",
  "version": "3.0.5-current",
  "name": "IHE_PIXm_pix",
  "title": "Get Corresponding Identifiers Operation",
  "status": "active",
  "kind": "operation",
  "date": "2022-05-25",
  "publisher": "IHE IT Infrastructure Technical Committee",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    },
    {
      "name": "IHE IT Infrastructure Technical Committee",
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    }
  ],
  "description": "The OperationDefinition defines the In and Output Parameters for the $ihe-pix operation\n - Input: sourceIdentifier, targetSystem and _format\n - Output: targetIdentifier, targetId",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "code": "ihe-pix",
  "resource": [
    "Patient"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "inputProfile": "https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Query.Parameters.In",
  "outputProfile": "https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Query.Parameters.Out",
  "parameter": [
    {
      "name": "sourceIdentifier",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The Patient identifier search parameter that will be used by the Patient Identifier Cross-reference Manager to find cross matching identifiers associated with the Patient Resource. See Section 3.83.4.1.2.1.",
      "type": "string",
      "searchType": "token"
    },
    {
      "name": "targetSystem",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The target Patient Identifier Assigning Authority from which the returned identifiers should be selected. See Section 3.83.4.1.2.2.",
      "type": "string",
      "searchType": "uri"
    },
    {
      "name": "_format",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The requested format of the response. See ITI TF-2: Appendix Z.6",
      "type": "string",
      "searchType": "token"
    },
    {
      "name": "targetIdentifier",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "The identifier found. Constraints to include the assigning authority as specified in ITI TF-2: Appendix E.3",
      "type": "Identifier"
    },
    {
      "name": "targetId",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "The URL of the Patient Resource",
      "type": "Reference"
    }
  ]
}