{
  "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.test",
  "format": [ "json", "xml" ],
  "date": "2020-03-06",
  "publisher": null,
  "fhirVersion": "4.0.0",
  "name": "PersonServerRequirements",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": "Requirements for Grunndata Person Service Interface",
  "package_version": "2.2.0",
  "status": "draft",
  "id": "2d14a9af-f1a7-49e6-91c3-4fa7537b4462",
  "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": "gender",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Search on Person.gender: GET [base]/Person?gender=[code]"
      }, {
        "name": "address",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "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. Search on Person.address: GET [base]/Person?address=[string]"
      }, {
        "name": "address-city",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "A city specified in an address. Search on Person.address.city: GET [base]/Person?address.city=[string]"
      }, {
        "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: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]"
      }, {
        "name": "relationship",
        "type": "token",
        "documentation": "Search on RelatedPerson.relationship: GET [base]/RelatedPerson?relationship=[system]|[code]"
      } ],
      "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" ]
    } ]
  } ]
}