Master Person Index R4

Read and Search roadmap

Roadmap for API requirements

The capabilities available in the API for the Person Information service will be extended in the next release planned for the end of this year (2020). The following CapabilityStatement describes the Capabilities of the next release. The next release will offer a more complete support for search and and add support for Provenance interactions.

PersonServerRequirements

RESTful Interactions

ModeServer

Resource TypeProfileSearchTypeReadVreadHistoryInstanceHistoryType
PersonGdPerson
RelatedPersonGdRelatedPerson
ProvenanceGdProvenance

Search Parameters per resource type

Person

NameTypeDocumentationLevel
_idtokenSearch on Person by logical id of the Resource: ``` GET [base]/Person?_id=[id] GET [base]/Person/[id] ```SHALL
identifiertokenSearch on Person.identifier: POST [base]/Person/_search parameters in HTTP body: identifier=[system]|[code] Example: POST [base]/Person/_search parameters in HTTP body: identifier=urn:oid:2.16.578.1....SHALL
namestringSearch on Person.name: GET [base]/Person?name=[string]SHALL
birthDatedateSearch on Person.birthDate: GET [base]/Person?birthDate=[date]SHALL
gendertokenSearch on Person.gender: GET [base]/Person?gender=[code]SHALL
addressstringA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text. Search on Person.address: GET [base]/Person?add...SHALL
address-citystringA city specified in an address. Search on Person.address.city: GET [base]/Person?address.city=[string]SHALL
gdaddresstypetokenSearchParameter for the freg type of gd-AddressesSHALL
addresscontenttypetokenSearchParameter for the content type of gd-AddressesSHALL
middlenamestringSearchParameter for the Norwegian middlename extension http://hl7.no/fhir/StructureDefinition/no-basis-middlenameSHALL
givenstringSearch on Person.given name: GET [base]/Person?given=[string]SHALL
familystringSearch on Person.family name: GET [base]/Person?family=[string]SHALL
_languagestringThe language of the resourceSupported
address-statestringA state specified in an addressSupported
gendertokenThe gender of the personSupported
practitionerreferenceThe Person links to this PractitionerSupported
relatedpersonreferenceThe Person links to this RelatedPersonSupported
address-postalcodestringA postal code specified in an addressSupported
address-countrystringA country specified in an addressSupported
phoneticstringA portion of name using some kind of phonetic matching algorithmSupported
phonetokenA value in a phone contactSupported
patientreferenceThe Person links to this PatientSupported
organizationreferenceThe organization at which this person record is being managedSupported
address-usetokenA use code specified in an addressSupported
telecomtokenThe value in any kind of contactSupported
address-citystringA city specified in an addressSupported
emailtokenA value in an email contactSupported

Supported Includes:

  • *
  • Person:link
  • Person:organization
  • Person:patient
  • Person:practitioner
  • Person:relatedperson

Supported Reverse Includes:

  • RelatedPerson:patient
  • Provenance:target

RelatedPerson

NameTypeDocumentationLevel
_idtokenSearch on RelatedPerson by logical id of the Resource: GET [base]/RelatedPerson?_id=[id] or GET [base]/RelatedPerson/[id]SHALL
identifiertokenSearch on RelatedPerson.identifier: POST [base]/RelatedPerson/_search parameters in HTTP body: identifier=[system]|[code] Example: POST [base]/RelatedPerson/_search parameters in HTTP body: identifier...SHALL
patientreferenceSearch on RelatedPerson.patient reference: GET [base]/RelatedPerson?patient:identifier=[system]|[code] Example: GET [base]/RelatedPerson?patient:identifier=urn:oid:2.16.578.1.12.4.1.4.1|04021950128SHALL
namestringSearch on RelatedPerson.name: GET [base]/RelatedPerson?name=[string]Supported
relationshiptokenSearch on relationshiptype RelatedPerson.relationship: GET [base]/RelatedPerson?relationship=[system]|[code]Supported
_languagestringThe language of the resourceSupported
gdaddresstypetokenSearchParameter for the freg type of gd-AddressesSupported
addressstringA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or textSupported
birthdatedateThe Related Person's date of birthSupported
gendertokenGender of the related personSupported
addresscontenttypetokenSearchParameter for the content type of gd-AddressesSupported
activetokenIndicates if the related person record is activeSupported
address-postalcodestringA postal code specified in an addressSupported
address-countrystringA country specified in an addressSupported
phoneticstringA portion of name using some kind of phonetic matching algorithmSupported
phonetokenA value in a phone contactSupported
address-usetokenA use code specified in an addressSupported
address-citystringA city specified in an addressSupported

Supported Includes:

  • RelatedPerson:patient

Supported Reverse Includes:

  • Provenance:target

Provenance

NameTypeDocumentationLevel
_idtokenSearch on Provenance by logical id of the Resource: GET [base]/Provenance?_id=[id] or GET [base]/Provenance/[id]SHALL
targetreferenceSearch on Provenance.target: GET [base]/Provenance?target=[reference] Example: GET [base]/Provenance?target=Person/53098SHALL
entityreferenceSearch on Provenance.entity reference: GET [base]/Provenance?entity=[reference] Example: GET [base]/Provenance?entity=Person/53098Supported
recordeddateSearch on Provenance.recorded: GET [base]/Provenance?recorded=[date] Example: GET [base]Provenance?recorded=gt2019-10-14T10:00&_sort=_idSHALL
_languagestringThe language of the resourceSupported
agent-typetokenHow the agent participatedSupported
agentreferenceWho participatedSupported
signature-typetokenIndication of the reason the entity signed the object(s)Supported
patientreferenceTarget Reference(s) (usually version specific)Supported
locationreferenceWhere the activity occurred, if relevantSupported
agent-roletokenWhat the agents role wasSupported
whendateWhen the activity occurredSupported

Supported Includes:

  • *
  • Provenance:agent
  • Provenance:entity
  • Provenance:target
  • Provenance:location
  • Provenance:patient

Documents

ModeProfileDocumentation