{
"description": "Requirements for the Grunndata Person service provided by Direktoratet for e-helse",
"_filename": "gd-Person-Server-Requirements-v300.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": "555c1b9d-3ea5-4dd2-b98f-872390381b66",
"kind": "requirements",
"url": "http://ehelse.no/fhir/CapabilityStatement/gd-Person-Server-Requirements/v300",
"version": "3.0.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."
}, {
"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: 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": "gdaddresstype",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://ehelse.no/fhir/SearchParameter/gd-Address-type",
"documentation": "SearchParameter for the freg type of gd-Addresses"
}, {
"name": "addresscontenttype",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://ehelse.no/fhir/SearchParameter/gd-Address-contenttype",
"documentation": "SearchParameter for the content type of gd-Addresses"
}, {
"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]"
}, {
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
}, {
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
}, {
"name": "gender",
"type": "token",
"documentation": "The gender of the person"
}, {
"name": "practitioner",
"type": "reference",
"documentation": "The Person links to this Practitioner"
}, {
"name": "relatedperson",
"type": "reference",
"documentation": "The Person links to this RelatedPerson"
}, {
"name": "address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
}, {
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
}, {
"name": "phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
}, {
"name": "phone",
"type": "token",
"documentation": "A value in a phone contact"
}, {
"name": "patient",
"type": "reference",
"documentation": "The Person links to this Patient"
}, {
"name": "organization",
"type": "reference",
"documentation": "The organization at which this person record is being managed"
}, {
"name": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
}, {
"name": "telecom",
"type": "token",
"documentation": "The value in any kind of contact"
}, {
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
}, {
"name": "email",
"type": "token",
"documentation": "A value in an email contact"
} ],
"searchInclude": [ "*", "Person:link", "Person:organization", "Person:patient", "Person:practitioner", "Person:relatedperson" ],
"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: 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" ]
} ]
} ]
}