{
  "description": "Requirements for the Grunndata Person service provided by Direktoratet for e-helse. Requirements for the test deliverable (L0).",
  "_filename": "gd-Person-Server-Requirements.json",
  "package_name": "ehelse.fhir.no.grunndata",
  "format": [ "json", "xml" ],
  "date": "2020-03-25",
  "publisher": null,
  "fhirVersion": "4.0.0",
  "name": "PersonServerRequirements",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": "Requirements for Grunndata Person Service Interface (server)",
  "package_version": "2.3.2",
  "status": "draft",
  "id": "b1951eef-cd46-4389-bbe6-dc7b8b5c9e6a",
  "kind": "requirements",
  "url": "http://ehelse.no/fhir/CapabilityStatement/gd-Person-Server-Requirements/v220",
  "version": "2.2.0",
  "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."
      } ],
      "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: 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.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": "middlename",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.no/fhir/SearchParameter/no-basis-middlename",
        "documentation": "SearchParameter for the Norwegian middlename extension http://hl7.no/fhir/StructureDefinition/no-basis-middlename"
      }, {
        "name": "given",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Search on Person.given name: GET [base]/Person?given=[string]"
      }, {
        "name": "family",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Search on Person.family name: GET [base]/Person?family=[string]"
      } ]
    }, {
      "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: POST [base]/RelatedPerson/_search parameters in HTTP body: identifier=[system]|[code] Example: POST [base]/RelatedPerson/_search parameters in HTTP body: 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=Person/[id]"
      }, {
        "name": "relationship",
        "type": "token",
        "documentation": "Search on relationshiptype RelatedPerson.relationship: GET [base]/RelatedPerson?relationship=[system]|[code]"
      } ]
    } ],
    "documentation": "The server must support a subset of the FHIR restful interactions described by HL7. Some special notes concerning the Capabilities offered by the server can be found in the ImplementationGuide for the service. ## Limiting the search result  ### The server expects _elements  The server expects all read and search interactions to use the _elements operation specifying what elements should be included in the search result. In the case where the _elements operation is missing a resouce containing only the identifier element is returned.  ###  To limit the returned resource instances the FHIR server supports the use of the _elements operation.  The operation MUST be added to any search to limit the information returned in the search result like this  ``` GET http:%2F%2Fhapi.fhir.org%2FbaseR4%2FPerson%3Fname%3DEspen%26_elements%3Dname%2Caddress ```"
  } ]
}