FHIRsmith: OperationDefinition/OperationDefinition-patient-foreign.json

FHIR IG analytics

Package	ee.fhir.mpi
Resource Type	OperationDefinition
Id	OperationDefinition-patient-foreign.json
FHIR Version	R5
Source	https://fhir.ee/packages/mpi/1.5.0/site/OperationDefinition-patient-foreign.html
URL	https://fhir.ee/mpi/OperationDefinition/patient-foreign
Version	1.5.0
Status	active
Date	2025-10-31T12:34:39+00:00
Name	EEMPIPatientForeignSearch
Title	Patient Foreign
Realm	ee
Description	The foreign operation perform complex search over non-estonian patient resources.
Type	true
Kind	operation

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 patient-foreign

URL: [base]/Patient/$foreign

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

identifier-country

1..1

string

Three-letter country code of the identifier issuer according to the ISO standard.

birthdate

0..1

date

Patient's date of birth in yyyy-mm-dd format.

gender

0..1

string

Patient's gender.

given

0..1

string

Given name. Search supports similarity, allows up to 2 typos, case-insensitive. Comma-separated values are allowed.

family

0..1

string

Family name. Search supports similarity, allows up to 2 typos, case-insensitive. Comma-separated values are allowed.

telecom

0..1

string

Telecom value, e-mail or phone number. Case-insensitive. Comma-separated values are allowed.

OUT

return

1..1

Bundle

Returns Bundle (with type collection) with Patient instances.

Source1

{
  "resourceType": "OperationDefinition",
  "id": "patient-foreign",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.ee/mpi/OperationDefinition/patient-foreign",
  "version": "1.5.0",
  "name": "EEMPIPatientForeignSearch",
  "title": "Patient Foreign",
  "status": "active",
  "kind": "operation",
  "experimental": false,
  "date": "2025-10-31T12:34:39+00:00",
  "publisher": "TEHIK",
  "contact": [
    {
      "name": "TEHIK",
      "telecom": [
        {
          "system": "url",
          "value": "https://tehik.ee"
        }
      ]
    }
  ],
  "description": "The foreign operation perform complex search over non-estonian patient resources.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "EE",
          "display": "Estonia"
        }
      ]
    }
  ],
  "affectsState": false,
  "code": "foreign",
  "resource": [
    "Patient"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "identifier-country",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Three-letter country code of the identifier issuer according to the ISO standard.",
      "type": "string"
    },
    {
      "name": "birthdate",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Patient's date of birth in yyyy-mm-dd format.",
      "type": "date"
    },
    {
      "name": "gender",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Patient's gender.",
      "type": "string"
    },
    {
      "name": "given",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Given name. Search supports similarity, allows up to 2 typos, case-insensitive. Comma-separated values are allowed.",
      "type": "string"
    },
    {
      "name": "family",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Family name. Search supports similarity, allows up to 2 typos, case-insensitive. Comma-separated values are allowed.",
      "type": "string"
    },
    {
      "name": "telecom",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Telecom value, e-mail or phone number. Case-insensitive. Comma-separated values are allowed.",
      "type": "string"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Returns Bundle (with type collection) with Patient instances.",
      "type": "Bundle"
    }
  ]
}