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.
RESTful Interactions
| Mode | Server |
| Resource Type | Profile | SearchType | Read | Vread | HistoryInstance | HistoryType |
|---|---|---|---|---|---|---|
| Person | GdPerson | ✓ | ✓ | ✓ | ✓ | ✓ |
| RelatedPerson | GdRelatedPerson | ✓ | ✓ | ✓ | ✓ | ✓ |
| Provenance | GdProvenance | ✓ | ✓ | ✓ |
Global Search Parameters
| Name | Type | Documentation | Level |
|---|---|---|---|
| _total | token | This server have a default value of *none* set for the _total parameter. The default value reduce the server load for large search-sets. The default behaviour can be changed by setting the _total para... | SHALL |
| _elements | string | The server expects _elements parameter to be set. The server expects all read and search interactions to use the *_elements* operation specifying what elements should be included in the search result.... | SHALL |
Search Parameters per resource type
Person
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Search on Person by logical id of the Resource: ``` GET [base]/Person?_id=[id] GET [base]/Person/[id] ``` | SHALL |
| identifier | token | Search 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 |
| name | string | Search on Person.name: GET [base]/Person?name=[string] | SHALL |
| birthdate | date | Search on Person.birthdate: GET [base]/Person?birthdate=[date] | SHALL |
| gender | token | Search on Person.gender: GET [base]/Person?gender=[code] | SHALL |
| 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. Search on Person.address: GET [base]/Person?add... | SHALL |
| address-city | string | A city specified in an address. Search on Person.address.city: GET [base]/Person?address.city=[string] | SHALL |
| gdaddresstype | token | SearchParameter for the freg type of gd-Addresses | SHALL |
| addresscontenttype | token | SearchParameter for the content type of gd-Addresses | SHALL |
| middlename | string | SearchParameter for the Norwegian middlename extension http://hl7.no/fhir/StructureDefinition/no-basis-middlename | SHALL |
| given | string | Search on Person.given name: GET [base]/Person?given=[string] | SHALL |
| family | string | Search on Person.family name: GET [base]/Person?family=[string] | SHALL |
| _language | string | The language of the resource | Supported |
| address-state | string | A state specified in an address | Supported |
| practitioner | reference | The Person links to this Practitioner | Supported |
| relatedperson | reference | The Person links to this RelatedPerson | Supported |
| address-postalcode | string | A postal code specified in an address | Supported |
| address-country | string | A country specified in an address | Supported |
| phonetic | string | A portion of name using some kind of phonetic matching algorithm | Supported |
| phone | token | A value in a phone contact | Supported |
| patient | reference | The Person links to this Patient | Supported |
| organization | reference | The organization at which this person record is being managed | Supported |
| address-use | token | A use code specified in an address | Supported |
| telecom | token | The value in any kind of contact | Supported |
| token | A value in an email contact | Supported |
Supported Includes:
- *
- Person:link
- Person:organization
- Person:patient
- Person:practitioner
- Person:relatedperson
Supported Reverse Includes:
- RelatedPerson:patient
- Provenance:target
RelatedPerson
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Search on RelatedPerson by logical id of the Resource: GET [base]/RelatedPerson?_id=[id] or GET [base]/RelatedPerson/[id] | SHALL |
| identifier | token | Search 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 |
| patient | reference | Search 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|04021950128 | SHALL |
| name | string | Search on RelatedPerson.name: GET [base]/RelatedPerson?name=[string] | Supported |
| relationship | token | Search on relationshiptype RelatedPerson.relationship: GET [base]/RelatedPerson?relationship=[system]|[code] | Supported |
| _language | string | The language of the resource | Supported |
| gdaddresstype | token | SearchParameter for the freg type of gd-Addresses | Supported |
| 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 | Supported |
| birthdate | date | The Related Person's date of birth | Supported |
| gender | token | Gender of the related person | Supported |
| addresscontenttype | token | SearchParameter for the content type of gd-Addresses | Supported |
| active | token | Indicates if the related person record is active | Supported |
| address-postalcode | string | A postal code specified in an address | Supported |
| address-country | string | A country specified in an address | Supported |
| phonetic | string | A portion of name using some kind of phonetic matching algorithm | Supported |
| phone | token | A value in a phone contact | Supported |
| address-use | token | A use code specified in an address | Supported |
| address-city | string | A city specified in an address | Supported |
Supported Includes:
- RelatedPerson:patient
Supported Reverse Includes:
- Provenance:target
Provenance
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Search on Provenance by logical id of the Resource: GET [base]/Provenance?_id=[id] or GET [base]/Provenance/[id] | SHALL |
| target | reference | Search on Provenance.target: GET [base]/Provenance?target=[reference] Example: GET [base]/Provenance?target=Person/53098 | SHALL |
| entity | reference | Search on Provenance.entity reference: GET [base]/Provenance?entity=[reference] Example: GET [base]/Provenance?entity=Person/53098 | Supported |
| recorded | date | Search on Provenance.recorded: GET [base]/Provenance?recorded=[date] Example: GET [base]Provenance?recorded=gt2019-10-14T10:00&_sort=_id | SHALL |
| _language | string | The language of the resource | Supported |
| agent-type | token | How the agent participated | Supported |
| agent | reference | Who participated | Supported |
| signature-type | token | Indication of the reason the entity signed the object(s) | Supported |
| patient | reference | Target Reference(s) (usually version specific) | Supported |
| location | reference | Where the activity occurred, if relevant | Supported |
| agent-role | token | What the agents role was | Supported |
| when | date | When the activity occurred | Supported |
Supported Includes:
- *
- Provenance:agent
- Provenance:entity
- Provenance:target
- Provenance:location
- Provenance:patient
Documents
| Mode |
|---|