FHIR Release 3 (STU) CI-Build

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

Capabilitystatement-phr-example.ttl

Example CapabilityStatement/phr (Turtle)

Maturity Level : N/A
Responsible Owner: FHIR Infrastructure Work Group Ballot Standards Status : Informative Compartments : Not linked to any No defined compartments

Raw Turtle , JSON-LD (+ also see Turtle/RDF Format Specification )

PHR Example 

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .

@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/CapabilityStatement/phr> a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "phr"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.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>"
  ];
  fhir:CapabilityStatement.name [ fhir:value "PHR Template"];
  fhir:CapabilityStatement.status [ fhir:value "draft"];
  fhir:CapabilityStatement.date [ fhir:value "2013-06-18"^^xsd:date];
  fhir:CapabilityStatement.publisher [ fhir:value "FHIR Project"];
  fhir:CapabilityStatement.contact [
     fhir:index 0;
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ]
  ];
  fhir:CapabilityStatement.description [ fhir:value "Prototype Capability Statement for September 2013 Connectathon"];
  fhir:CapabilityStatement.kind [ fhir:value "capability"];
  fhir:CapabilityStatement.software [
     fhir:CapabilityStatement.software.name [ fhir:value "ACME PHR Server" ]
  ];
  fhir:CapabilityStatement.fhirVersion [ fhir:value "1.0.0"];
  fhir:CapabilityStatement.acceptUnknown [ fhir:value "no"];
  fhir:CapabilityStatement.format [
     fhir:value "json";
     fhir:index 0
  ], [
     fhir:value "xml";
     fhir:index 1
  ];
  fhir:CapabilityStatement.rest [
     fhir:index 0;
     fhir:CapabilityStatement.rest.mode [ fhir:value "server" ];
     fhir:CapabilityStatement.rest.documentation [ fhir:value "Protoype server Capability Statement for September 2013 Connectathon" ];
     fhir:CapabilityStatement.rest.security [
       fhir:CapabilityStatement.rest.security.service [
         fhir:index 0;
         fhir:CodeableConcept.text [ fhir:value "OAuth" ]
       ];
       fhir:CapabilityStatement.rest.security.description [ fhir:value "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" ]
     ];
     fhir:CapabilityStatement.rest.resource [
       fhir:index 0;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Patient" ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ];
         fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "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" ]
       ]
     ], [
       fhir:index 1;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "DocumentReference" ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "_id" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "_id parameter always supported. For the connectathon, servers may elect which search parameters are supported" ]
       ]
     ], [
       fhir:index 2;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Condition" ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "_id" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Standard _id parameter" ]
       ]
     ], [
       fhir:index 3;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "DiagnosticReport" ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "_id" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Standard _id parameter" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "service" ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "which diagnostic discipline/department created the report" ]
       ]

<http://hl7.org/fhir/CapabilityStatement/phr> a fhir:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "phr"] ; # 
  fhir:text [
     fhir:status [ fhir:v "generated" ] ;
     fhir:div [ fhir:v "<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>"^^rdf:XMLLiteral ]
  ] ; # 
  fhir:extension ( [
     fhir:url [
       fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ;
       fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-wg>
     ] ;
     fhir:value [
       a fhir:Code ;
       fhir:v "fhir"

     ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/CapabilityStatement/phr.ttl> a owl:Ontology;
  owl:imports fhir:fhir.ttl;
  owl:versionIRI <http://hl7.org/fhir/STU3/CapabilityStatement/phr.ttl> .

  ] ) ; # 
  fhir:identifier ( [
     fhir:system [
       fhir:v "urn:ietf:rfc:3986"^^xsd:anyURI ;
       fhir:l <urn:ietf:rfc:3986>
     ] ;
     fhir:value [ fhir:v "urn:oid:2.16.840.1.113883.4.642.34.7" ]
  ] ) ; # 
  fhir:name [ fhir:v "PHRTemplate"] ; # 
  fhir:title [ fhir:v "PHR Template"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:date [ fhir:v "2013-06-18"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "HL7 International / FHIR Infrastructure"] ; # 
  fhir:contact ( [
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ]
     ] )
  ] ) ; # 
  fhir:description [ fhir:v "Prototype Capability Statement for September 2013 Connectathon"] ; # 
  fhir:kind [ fhir:v "capability"] ; # 
  fhir:software [
     fhir:name [ fhir:v "ACME PHR Server" ]
  ] ; # 
  fhir:fhirVersion [ fhir:v "6.0.0"] ; # 
  fhir:format ( [ fhir:v "json"] [ fhir:v "xml"] ) ; # 
  fhir:rest ( [
     fhir:mode [ fhir:v "server" ] ;
     fhir:documentation [ fhir:v "Protoype server Capability Statement for September 2013 Connectathon" ] ;
     fhir:security [
       fhir:service ( [
         fhir:text [ fhir:v "OAuth" ]
       ] ) ;
       fhir:description [ fhir:v "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" ]
     ] ;
     fhir:resource ( [
       fhir:type [
         fhir:v "Patient"^^xsd:anyURI ;
         fhir:l fhir:Patient
       ] ;
       fhir:interaction ( [
         fhir:code [ fhir:v "read" ]
       ] [
         fhir:code [ fhir:v "search-type" ] ;
         fhir:documentation [ fhir:v "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" ]
       ] )
     ] [
       fhir:type [
         fhir:v "DocumentReference"^^xsd:anyURI ;
         fhir:l fhir:DocumentReference
       ] ;
       fhir:interaction ( [
         fhir:code [ fhir:v "read" ]
       ] [
         fhir:code [ fhir:v "search-type" ]
       ] ) ;
       fhir:searchParam ( [
         fhir:name [ fhir:v "_id" ] ;
         fhir:type [ fhir:v "token" ] ;
         fhir:documentation [ fhir:v "_id parameter always supported. For the connectathon, servers may elect which search parameters are supported" ]
       ] )
     ] [
       fhir:type [
         fhir:v "Condition"^^xsd:anyURI ;
         fhir:l fhir:Condition
       ] ;
       fhir:interaction ( [
         fhir:code [ fhir:v "read" ]
       ] [
         fhir:code [ fhir:v "search-type" ]
       ] ) ;
       fhir:searchParam ( [
         fhir:name [ fhir:v "_id" ] ;
         fhir:type [ fhir:v "token" ] ;
         fhir:documentation [ fhir:v "Standard _id parameter" ]
       ] )
     ] [
       fhir:type [
         fhir:v "DiagnosticReport"^^xsd:anyURI ;
         fhir:l fhir:DiagnosticReport
       ] ;
       fhir:interaction ( [
         fhir:code [ fhir:v "read" ]
       ] [
         fhir:code [ fhir:v "search-type" ]
       ] ) ;
       fhir:searchParam ( [
         fhir:name [ fhir:v "_id" ] ;
         fhir:type [ fhir:v "token" ] ;
         fhir:documentation [ fhir:v "Standard _id parameter" ]
       ] [
         fhir:name [ fhir:v "service" ] ;
         fhir:type [ fhir:v "token" ] ;
         fhir:documentation [ fhir:v "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.