FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/gd-Person-Server-Requirements

Packageehelse.fhir.no.grunndata.test
Resource TypeCapabilityStatement
Idgd-Person-Server-Requirements
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=ehelse.fhir.no.grunndata.test@2.3.3&canonical=http://ehelse.no/fhir/CapabilityStatement/gd-Person-Server-Requirements/v220
URLhttp://ehelse.no/fhir/CapabilityStatement/gd-Person-Server-Requirements/v220
Version2.2.0
Statusdraft
Date2020-03-25
NamePersonServerRequirements
TitleRequirements for Grunndata Person Service Interface (server)
DescriptionRequirements for the Grunndata Person service provided by Direktoratet for e-helse. Requirements for the test deliverable (L0).
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

SearchParameter
no-basis-middlenameNoBasisMiddlename
StructureDefinition
gd-PersonGdPerson
gd-RelatedPersonGdRelatedPerson

Narrative

No narrative content found in resource


Source

{
  "resourceType": "CapabilityStatement",
  "url": "http://ehelse.no/fhir/CapabilityStatement/gd-Person-Server-Requirements/v220",
  "version": "2.2.0",
  "name": "PersonServerRequirements",
  "title": "Requirements for Grunndata Person Service Interface (server)",
  "status": "draft",
  "date": "2020-03-25",
  "description": "Requirements for the Grunndata Person service provided by Direktoratet for e-helse. Requirements for the test deliverable (L0).",
  "kind": "requirements",
  "fhirVersion": "4.0.0",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "mode": "server",
      "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 ```",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
              "extension": [
                {
                  "url": "required",
                  "valueString": "name"
                },
                {
                  "url": "required",
                  "valueString": "birthdate"
                }
              ]
            }
          ],
          "type": "Person",
          "profile": "http://ehelse.no/fhir/StructureDefinition/gd-Person",
          "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": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "type": "token",
              "documentation": "Search on Person by logical id of the Resource:       ```      GET [base]/Person?_id=[id]      GET [base]/Person/[id]      ```"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token",
              "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "type": "string",
              "documentation": "Search on Person.name: GET [base]/Person?name=[string]"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "birthDate",
              "type": "date",
              "documentation": "Search on Person.birthDate: GET [base]/Person?birthDate=[date]"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "middlename",
              "definition": "http://hl7.no/fhir/SearchParameter/no-basis-middlename",
              "type": "string",
              "documentation": "SearchParameter for the Norwegian middlename extension http://hl7.no/fhir/StructureDefinition/no-basis-middlename"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "given",
              "type": "string",
              "documentation": "Search on Person.given name: GET [base]/Person?given=[string]"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "family",
              "type": "string",
              "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": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "type": "token",
              "documentation": "Search on RelatedPerson by logical id of the Resource: GET [base]/RelatedPerson?_id=[id] or GET [base]/RelatedPerson/[id]"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token",
              "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "reference",
              "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]"
            }
          ]
        }
      ]
    }
  ]
}