FHIR IG Statistics: CapabilityStatement/gd-Person-Server-Requirements-v300
Resources that use this resource
No resources found
Resources that this resource uses
Narrative
No narrative content found in resource
Source
{
"resourceType": "CapabilityStatement",
"url": "http://ehelse.no/fhir/CapabilityStatement/gd-Person-Server-Requirements/v300",
"version": "3.0.0",
"name": "PersonServerRequirements",
"title": "Requirements for Grunndata Person Service Interface (server)",
"status": "draft",
"date": "2020-03-06",
"description": "Requirements for the Grunndata Person service provided by Direktoratet for e-helse. Requirements for the test deliverable (L1).",
"kind": "requirements",
"fhirVersion": "4.0.0",
"format": [
"json",
"xml"
],
"rest": [
{
"mode": "server",
"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."
},
{
"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."
}
],
"searchInclude": [
"*",
"Person:link",
"Person:organization",
"Person:patient",
"Person:practitioner",
"Person:relatedperson"
],
"searchRevInclude": [
"RelatedPerson:patient",
"Provenance:target"
],
"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": "gender",
"type": "token",
"documentation": "Search on Person.gender: GET [base]/Person?gender=[code]"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "address",
"type": "string",
"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]"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address. Search on Person.address.city: GET [base]/Person?address.city=[string]"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "gdaddresstype",
"definition": "http://ehelse.no/fhir/SearchParameter/gd-Address-type",
"type": "token",
"documentation": "SearchParameter for the freg type of gd-Addresses"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "addresscontenttype",
"definition": "http://ehelse.no/fhir/SearchParameter/gd-Address-contenttype",
"type": "token",
"documentation": "SearchParameter for the content type of gd-Addresses"
},
{
"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]"
},
{
"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"
}
]
},
{
"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."
},
{
"code": "history-instance"
},
{
"code": "history-type"
}
],
"searchInclude": [
"RelatedPerson:patient"
],
"searchRevInclude": [
"Provenance:target"
],
"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: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 relationshiptype RelatedPerson.relationship: GET [base]/RelatedPerson?relationship=[system]|[code]"
},
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "gdaddresstype",
"type": "token",
"documentation": "SearchParameter for the freg type of gd-Addresses"
},
{
"name": "address",
"type": "string",
"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"
},
{
"name": "birthdate",
"type": "date",
"documentation": "The Related Person's date of birth"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the related person"
},
{
"name": "addresscontenttype",
"type": "token",
"documentation": "SearchParameter for the content type of gd-Addresses"
},
{
"name": "active",
"type": "token",
"documentation": "Indicates if the related person record is active"
},
{
"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": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
}
]
},
{
"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."
}
],
"searchInclude": [
"*",
"Provenance:agent",
"Provenance:entity",
"Provenance:target",
"Provenance:location",
"Provenance:patient"
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"type": "token",
"documentation": "Search on Provenance by logical id of the Resource: GET [base]/Provenance?_id=[id] or GET [base]/Provenance/[id]"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "target",
"type": "reference",
"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"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "recorded",
"type": "date",
"documentation": "Search on Provenance.recorded: GET [base]/Provenance?recorded=[date] Example: GET [base]Provenance?recorded=gt2019-10-14T10:00&_sort=_id"
},
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "agent-type",
"type": "token",
"documentation": "How the agent participated"
},
{
"name": "agent",
"type": "reference",
"documentation": "Who participated"
},
{
"name": "signature-type",
"type": "token",
"documentation": "Indication of the reason the entity signed the object(s)"
},
{
"name": "patient",
"type": "reference",
"documentation": "Target Reference(s) (usually version specific)"
},
{
"name": "location",
"type": "reference",
"documentation": "Where the activity occurred, if relevant"
},
{
"name": "agent-role",
"type": "token",
"documentation": "What the agents role was"
},
{
"name": "when",
"type": "date",
"documentation": "When the activity occurred"
}
]
}
]
}
]
}
FHIR