{ "description": "Requirements for the Grunndata Person service provided by Direktoratet for e-helse", "_filename": "gd-Person-Server-Requirements.json", "package_name": "ehelse.fhir.no.grunndata", "format": [ "json", "xml" ], "date": "2019-11-07", "publisher": null, "fhirVersion": "4.0.0", "name": "PersonServerRequirements", "type": null, "experimental": null, "resourceType": "CapabilityStatement", "title": "Requirements for Grunndata Person Service Interface", "package_version": "2.1.0", "status": "draft", "id": "c00ae324-d534-4559-b1aa-3d5ec9307ef9", "kind": "requirements", "url": "http://ehelse.no/fhir/CapabilityStatement/gd-Person-Server-Requirements/v003", "version": null, "rest": [ { "mode": "server", "resource": [ { "type": "Person", "profile": "http://ehelse.no/fhir/StructureDefinition/gd-Person", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "name" }, { "url": "required", "valueString": "birthdate" } ] } ], "interaction": [ { "code": "search-type", "documentation": "Search for a specific Resource type on some specified filter criteria" }, { "code": "read", "documentation": "Normal read operation." }, { "code": "vread", "documentation": "Normal read operation on specific versions." }, { "code": "history-instance", "documentation": "Retrieve the change history for a particular resource." }, { "code": "history-type", "documentation": "Retrieve the change history for all resources of a particular type." } ], "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Person by logical id of the Resource: ``` GET [base]/Person?_id=[id] GET [base]/Person/[id] ```" }, { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Person.identifier: GET [base]/Person?identifier=[system]|[code] Example: GET [base]/Person?identifier=urn:oid:2.16.578.1.12.4.1.4.1|04021950128" }, { "name": "name", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Person.name: GET [base]/Person?name=[string]" }, { "name": "birthDate", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Person.birthDate: GET [base]/Person?birthDate=[date]" }, { "name": "gender", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Person.gender: GET [base]/Person?gender=[code]" } ], "searchRevInclude": [ "RelatedPerson:patient", "Provenance:target" ] }, { "type": "RelatedPerson", "profile": "http://ehelse.no/fhir/StructureDefinition/gd-RelatedPerson", "interaction": [ { "code": "search-type", "documentation": "Search for a specific Resource type on some specified filter criteria" }, { "code": "read", "documentation": "Normal read operation." }, { "code": "vread", "documentation": "Normal read operation on specific versions." } ], "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on RelatedPerson by logical id of the Resource: GET [base]/RelatedPerson?_id=[id] or GET [base]/RelatedPerson/[id]" }, { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on RelatedPerson.identifier: GET [base]/RelatedPerson?identifier=[system]|[code] Example: GET [base]/RelatedPatient?identifier=urn:oid:2.16.578.1.12.4.1.4.1|13116900216" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "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" }, { "name": "name", "type": "string", "documentation": "Search on RelatedPerson.name: GET [base]/RelatedPerson?name=[string]" } ], "searchInclude": [ "RelatedPerson:patient" ], "searchRevInclude": [ "Provenance:target" ] }, { "type": "Provenance", "profile": "http://ehelse.no/fhir/StructureDefinition/gd-Provenance", "interaction": [ { "code": "search-type", "documentation": "Search for a specific Resource type on some specified filter criteria" }, { "code": "read", "documentation": "Normal read operation." }, { "code": "vread", "documentation": "Normal read operation on specific versions." } ], "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Provenance by logical id of the Resource: GET [base]/Provenance?_id=[id] or GET [base]/Provenance/[id]" }, { "name": "target", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Provenance.target: GET [base]/Provenance?target=[reference] Example: GET [base]/Provenance?target=Person/53098" }, { "name": "entity", "type": "reference", "documentation": "Search on Provenance.entity reference: GET [base]/Provenance?entity=[reference] Example: GET [base]/Provenance?entity=Person/53098" }, { "name": "recorded", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Search on Provenance.recorded: GET [base]/Provenance?recorded=[date] Example: GET [base]Provenance?recorded=gt2019-10-14T10:00&_sort=_id" } ], "searchInclude": [ "Provenance:agent", "Provenance:entity", "Provenance:target" ] } ] } ] }