Conformance
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| Responsible Owner: FHIR Infrastructure Work Group |
|
Compartments
:
|
Raw JSON ( canonical form + also see JSON Format Specification )
PHR Example
{
"resourceType": "CapabilityStatement",
"id": "phr",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n \n <p>Prototype Capability Statement for September 2013 Connectathon</p>\n \n <p>The server offers read and search support on the following resource types:</p>\n \n <ul>\n \n <li>Patient</li>\n \n <li>DocumentReference</li>\n \n <li>Condition</li>\n \n <li>DiagnosticReport</li>\n \n </ul>\n \n </div>"
"resourceType" : "CapabilityStatement",
"id" : "phr",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Prototype Capability Statement for September 2013 Connectathon</p>\n <p>The server offers read and search support on the following resource types:</p>\n <ul>\n <li>Patient</li>\n <li>DocumentReference</li>\n <li>Condition</li>\n <li>DiagnosticReport</li>\n </ul>\n </div>"
},
"name": "PHR Template",
"status": "draft",
"date": "2013-06-18",
"publisher": "FHIR Project",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Prototype Capability Statement for September 2013 Connectathon",
"kind": "capability",
"software": {
"name": "ACME PHR Server"
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.34.7"
}],
"name" : "PHRTemplate",
"title" : "PHR Template",
"status" : "draft",
"date" : "2013-06-18",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}]
}],
"description" : "Prototype Capability Statement for September 2013 Connectathon",
"kind" : "capability",
"software" : {
"name" : "ACME PHR Server"
},
"fhirVersion": "1.0.0",
"acceptUnknown": "no",
"format": [
"json",
"xml"
],
"rest": [
"fhirVersion" : "6.0.0",
"format" : ["json",
"xml"],
"rest" : [{
"mode" : "server",
"documentation" : "Protoype server Capability Statement for September 2013 Connectathon",
"security" : {
"service" : [{
"text" : "OAuth"
}],
"description" : "We recommend that PHR servers use standard OAuth using a standard 3rd party provider. We are not testing the ability to provide an OAuth authentication/authorization service itself, and nor is providing any security required for the connectathon at all"
},
"resource" : [{
"type" : "Patient",
"interaction" : [{
"code" : "read"
},
{
"code" : "search-type",
"documentation" : "When a client searches patients with no search criteria, they get a list of all patients they have access too. Servers may elect to offer additional search parameters, but this is not required"
}]
},
{
"mode": "server",
"documentation": "Protoype server Capability Statement for September 2013 Connectathon",
"security": {
"service": [
{
"text": "OAuth"
}
],
"description": "We recommend that PHR servers use standard OAuth using a standard 3rd party provider. We are not testing the ability to provide an OAuth authentication/authorization service itself, and nor is providing any security required for the connectathon at all"
"type" : "DocumentReference",
"interaction" : [{
"code" : "read"
},
"resource": [
{
"type": "Patient",
"interaction": [
{
"code": "read"
},
{
"code": "search-type",
"documentation": "When a client searches patients with no search criteria, they get a list of all patients they have access too. Servers may elect to offer additional search parameters, but this is not required"
}
]
},
{
"type": "DocumentReference",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "_id parameter always supported. For the connectathon, servers may elect which search parameters are supported"
}
]
},
{
"type": "Condition",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "Standard _id parameter"
}
]
},
{
"type": "DiagnosticReport",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "Standard _id parameter"
},
{
"name": "service",
"type": "token",
"documentation": "which diagnostic discipline/department created the report"
}
]
}
]
}
]
{
"code" : "search-type"
}],
"searchParam" : [{
"name" : "_id",
"type" : "token",
"documentation" : "_id parameter always supported. For the connectathon, servers may elect which search parameters are supported"
}]
},
{
"type" : "Condition",
"interaction" : [{
"code" : "read"
},
{
"code" : "search-type"
}],
"searchParam" : [{
"name" : "_id",
"type" : "token",
"documentation" : "Standard _id parameter"
}]
},
{
"type" : "DiagnosticReport",
"interaction" : [{
"code" : "read"
},
{
"code" : "search-type"
}],
"searchParam" : [{
"name" : "_id",
"type" : "token",
"documentation" : "Standard _id parameter"
},
{
"name" : "service",
"type" : "token",
"documentation" : "which diagnostic discipline/department created the report"
}]
}]
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Thurs,
Oct
Mon,
Nov
24,
2019
11:53+1100.
QA
Page
2025
20:50+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change