| Package | ihe.iti.pdqm |
| Resource Type | CapabilityStatement |
| Id | IHE.PDQm.PatientDemographicsConsumerQuery |
| FHIR Version | R4 |
| Source | https://profiles.ihe.net/ITI/PDQm/https://build.fhir.org/ig/IHE/ITI.PDQm/CapabilityStatement-IHE.PDQm.PatientDemographicsConsumerQuery.html |
| URL | https://profiles.ihe.net/ITI/PDQm/CapabilityStatement/IHE.PDQm.PatientDemographicsConsumerQuery |
| Version | 3.1.1-current |
| Status | active |
| Date | 2022-10-28 |
| Name | IHE_PDQM_PATIENT_DEMOGRAPHICS_CONSUMER_SEARCH |
| Title | IHE PDQm Patient Demographics Consumer Implementing Patient Search Option |
| Realm | uv |
| Authority | ihe |
| Description | The PDQm Patient Demographics Consumer Actor (client) requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant. This capability statement implements the Patient Search Option. - Query against the FHIR endpoint to the Patient Resource endpoint - Using FHIR R4 - MAY request json or xml encoding - SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/) - [Search Parameters that MAY be used](ITI-78.html#23784121-search-parameters) - _id - active - family - given - identifier - telecom - birthdate - address - gender - mothersMaidenName |
| Kind | requirements |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.PDQm.PatientDemographicsConsumerQuery
FHIRapplication/fhir+xml, application/fhir+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
clientPDQm Patient Demographics Consumer provides capability to discover Patient Identities by demographics and identities.
Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
search-systeminteraction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | y | y | _lastUpdated, _id, active, family, given, identifier, telecom, birthdate, address, address-city, address-country, address-postalcode, address-state, gender, mothersMaidenName |
Mobile Patient Demographics Query [ITI-78]
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | _lastUpdated | date | When the resource version last changed |
| MAY | _id | token | Logical id of this artifact |
| MAY | active | token | Whether the patient record is active |
| MAY | family | string | A portion of the family name of the patient |
| MAY | given | string | A portion of the given name of the patient |
| MAY | identifier | token | A patient identifier |
| MAY | telecom | token | The value in any kind of telecom details of the patient |
| MAY | birthdate | date | The patient's date of birth |
| MAY | address | string | A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
| MAY | address-city | string | A city specified in an address |
| MAY | address-country | string | A country specified in an address |
| MAY | address-postalcode | string | A postalCode specified in an address |
| MAY | address-state | string | A state specified in an address |
| MAY | gender | token | Gender of the patient |
| MAY | mothersMaidenName | string | Mother's maiden (unmarried) name, commonly collected to help verify patient identity. |
{
"resourceType": "CapabilityStatement",
"id": "IHE.PDQm.PatientDemographicsConsumerQuery",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://profiles.ihe.net/ITI/PDQm/CapabilityStatement/IHE.PDQm.PatientDemographicsConsumerQuery",
"version": "3.1.1-current",
"name": "IHE_PDQM_PATIENT_DEMOGRAPHICS_CONSUMER_SEARCH",
"title": "IHE PDQm Patient Demographics Consumer Implementing Patient Search Option",
"status": "active",
"experimental": false,
"date": "2022-10-28",
"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 PDQm Patient Demographics Consumer Actor (client) requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant. This capability statement implements the Patient Search Option.\n\n- Query against the FHIR endpoint to the Patient Resource endpoint\n- Using FHIR R4\n- MAY request json or xml encoding\n- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)\n- [Search Parameters that MAY be used](ITI-78.html#23784121-search-parameters)\n - _id\n - active\n - family\n - given\n - identifier\n - telecom\n - birthdate\n - address\n - gender\n - mothersMaidenName",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"application/fhir+xml",
"application/fhir+json"
],
"rest": [
{
"mode": "client",
"documentation": "PDQm Patient Demographics Consumer provides capability to discover Patient Identities by demographics and identities.",
"security": {
"description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
},
"resource": [
{
"type": "Patient",
"documentation": "Mobile Patient Demographics Query [ITI-78]",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_id",
"type": "token",
"documentation": "Logical id of this artifact"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "active",
"type": "token",
"documentation": "Whether the patient record is active"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "family",
"type": "string",
"documentation": "A portion of the family name of the patient"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "given",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "identifier",
"type": "token",
"documentation": "A patient identifier"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "telecom",
"type": "token",
"documentation": "The value in any kind of telecom details of the patient"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "birthdate",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "address",
"type": "string",
"documentation": "A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "address-postalcode",
"type": "string",
"documentation": "A postalCode specified in an address"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "gender",
"type": "token",
"documentation": "Gender of the patient"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "mothersMaidenName",
"definition": "http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName",
"type": "string",
"documentation": "Mother's maiden (unmarried) name, commonly collected to help verify patient identity."
}
]
}
],
"interaction": [
{
"code": "search-system"
}
]
}
]
}