Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Capabilitystatement-example.ttl

Example CapabilityStatement/example (Turtle)

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

Raw Turtle (+ also see Turtle/RDF Format Specification )

General Condition Capability Example 

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

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

<http://hl7.org/fhir/CapabilityStatement/example> a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n			<p>The EHR Server supports the following transactions for the resource Person: read, vread, \n        update, history, search(name,gender), create and updates.</p>\n			<p>The EHR System supports the following message: admin-notify::Person.</p>\n			<p>The EHR Application has a \n        <a href=\"http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796\">general document profile</a>.\n      </p>\n		</div>"
  ];
  fhir:CapabilityStatement.url [ fhir:value "urn:uuid:68D043B5-9ECF-4559-A57A-396E0D452311"];
  fhir:CapabilityStatement.version [ fhir:value "20130510"];
  fhir:CapabilityStatement.name [ fhir:value "ACME-EHR"];
  fhir:CapabilityStatement.title [ fhir:value "ACME EHR capability statement"];
  fhir:CapabilityStatement.status [ fhir:value "draft"];
  fhir:CapabilityStatement.experimental [ fhir:value "true"^^xsd:boolean];
  fhir:CapabilityStatement.date [ fhir:value "2012-01-04"^^xsd:date];
  fhir:CapabilityStatement.publisher [ fhir:value "ACME Corporation"];
  fhir:CapabilityStatement.contact [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "System Administrator" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "email" ];
       fhir:ContactPoint.value [ fhir:value "wile@acme.org" ]
     ]
  ];
  fhir:CapabilityStatement.description [ fhir:value "This is the FHIR capability statement for the main EHR at ACME for the private interface - it does not describe the public interface"];
  fhir:CapabilityStatement.useContext [
     fhir:index 0;
     fhir:UsageContext.code [
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/usage-context-type" ];
       fhir:Coding.code [ fhir:value "focus" ]
     ];
     fhir:UsageContext.valueCodeableConcept [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/variant-state" ];
         fhir:Coding.code [ fhir:value "positive" ]
       ]
     ]
  ];
  fhir:CapabilityStatement.jurisdiction [
     fhir:index 0;
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
       fhir:Coding.code [ fhir:value "US" ];
       fhir:Coding.display [ fhir:value "United States of America (the)" ]

[a fhir:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "example"] ; # 
  fhir:text [
     fhir:status [ fhir:v "generated" ] ;
     fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n			\n      <p>The EHR Server supports the following transactions for the resource Person: read, vread, \n        update, history, search(name,gender), create and updates.</p>\n			\n      <p>The EHR System supports the following message: admin-notify::Person.</p>\n			\n      <p>The EHR Application has a \n        \n        <a href=\"http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796\">general document profile</a>.\n      \n      </p>\n		\n    </div>"
  ] ; # 
  fhir:url [ fhir:v "urn:uuid:68d043b5-9ecf-4559-a57a-396e0d452311"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "20130510"] ; # 
  fhir:name [ fhir:v "ACMEEHR"] ; # 
  fhir:title [ fhir:v "ACME EHR capability statement"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:experimental [ fhir:v "true"^^xsd:boolean] ; # 
  fhir:date [ fhir:v "2012-01-04"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "ACME Corporation"] ; # 
  fhir:contact ( [
     fhir:name [ fhir:v "System Administrator" ] ;
     fhir:telecom ( [
       fhir:system [ fhir:v "email" ] ;
       fhir:value [ fhir:v "wile@acme.org" ]
     ] )
  ] ) ; # 
  fhir:description [ fhir:v "This is the FHIR capability statement for the main EHR at ACME for the private interface - it does not describe the public interface"] ; # 
  fhir:useContext ( [
     fhir:code [
       fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/usage-context-type"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "focus" ]
     ] ;
     fhir:value [
       a fhir:CodeableConcept ;
       fhir:coding ( [
         fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/variant-state"^^xsd:anyURI ] ;
         fhir:code [ fhir:v "positive" ]
       ] )

     ]
  ];
  fhir:CapabilityStatement.purpose [ fhir:value "Main EHR capability statement, published for contracting and operational support"];
  fhir:CapabilityStatement.copyright [ fhir:value "Copyright © Acme Healthcare and GoodCorp EHR Systems"];
  fhir:CapabilityStatement.kind [ fhir:value "instance"];
  fhir:CapabilityStatement.instantiates [
     fhir:value "http://ihe.org/fhir/CapabilityStatement/pixm-client";
     fhir:index 0;

  ] ) ; # 
  fhir:jurisdiction ( [
     fhir:coding ( [
       fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "US" ] ;
       fhir:display [ fhir:v "United States of America (the)" ]
     ] )
  ] ) ; # 
  fhir:purpose [ fhir:v "Main EHR capability statement, published for contracting and operational support"] ; # 
  fhir:copyright [ fhir:v "Copyright © Acme Healthcare and GoodCorp EHR Systems"] ; # 
  fhir:kind [ fhir:v "instance"] ; # 
  fhir:instantiates ( [
     fhir:v "http://ihe.org/fhir/CapabilityStatement/pixm-client"^^xsd:anyURI ;

     fhir:link <http://ihe.org/fhir/CapabilityStatement/pixm-client>
  ];
  fhir:CapabilityStatement.software [
     fhir:CapabilityStatement.software.name [ fhir:value "EHR" ];
     fhir:CapabilityStatement.software.version [ fhir:value "0.00.020.2134" ];
     fhir:CapabilityStatement.software.releaseDate [ fhir:value "2012-01-04"^^xsd:date ]
  ];
  fhir:CapabilityStatement.implementation [
     fhir:CapabilityStatement.implementation.description [ fhir:value "main EHR at ACME" ];
     fhir:CapabilityStatement.implementation.url [ fhir:value "http://10.2.3.4/fhir" ]
  ];
  fhir:CapabilityStatement.fhirVersion [ fhir:value "4.0.1"];
  fhir:CapabilityStatement.format [
     fhir:value "xml";
     fhir:index 0
  ], [
     fhir:value "json";
     fhir:index 1
  ];
  fhir:CapabilityStatement.patchFormat [
     fhir:value "application/xml-patch+xml";
     fhir:index 0
  ], [
     fhir:value "application/json-patch+json";
     fhir:index 1
  ];
  fhir:CapabilityStatement.implementationGuide [
     fhir:value "http://hl7.org/fhir/us/lab";
     fhir:index 0;
     fhir:link <http://hl7.org/fhir/us/lab>
  ];
  fhir:CapabilityStatement.rest [
     fhir:index 0;
     fhir:CapabilityStatement.rest.mode [ fhir:value "server" ];
     fhir:CapabilityStatement.rest.documentation [ fhir:value "Main FHIR endpoint for acem health" ];
     fhir:CapabilityStatement.rest.security [
       fhir:CapabilityStatement.rest.security.cors [ fhir:value "true"^^xsd:boolean ];
       fhir:CapabilityStatement.rest.security.service [
         fhir:index 0;
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/restful-security-service" ];
           fhir:Coding.code [ fhir:value "SMART-on-FHIR" ]
         ]
       ];
       fhir:CapabilityStatement.rest.security.description [ fhir:value "See Smart on FHIR documentation" ]
     ];
     fhir:CapabilityStatement.rest.resource [
       fhir:index 0;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Patient" ];
       fhir:CapabilityStatement.rest.resource.profile [
         fhir:value "http://registry.fhir.org/r4/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416";
         fhir:link <http://registry.fhir.org/r4/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416>
       ];
       fhir:CapabilityStatement.rest.resource.supportedProfile [
         fhir:value "http://registry.fhir.org/r4/StructureDefinition/00ab9e7a-06c7-4f77-9234-4154ca1e3347";
         fhir:index 0;
         fhir:link <http://registry.fhir.org/r4/StructureDefinition/00ab9e7a-06c7-4f77-9234-4154ca1e3347>
       ];
       fhir:CapabilityStatement.rest.resource.documentation [ fhir:value "This server does not let the clients create identities." ];
       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 "vread" ];
         fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Only supported for patient records since 12-Dec 2012" ]
       ], [
         fhir:index 2;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "update" ]
       ], [
         fhir:index 3;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "history-instance" ]
       ], [
         fhir:index 4;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "create" ]
       ], [
         fhir:index 5;
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "history-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.versioning [ fhir:value "versioned-update" ];
       fhir:CapabilityStatement.rest.resource.readHistory [ fhir:value "true"^^xsd:boolean ];
       fhir:CapabilityStatement.rest.resource.updateCreate [ fhir:value "false"^^xsd:boolean ];
       fhir:CapabilityStatement.rest.resource.conditionalCreate [ fhir:value "true"^^xsd:boolean ];
       fhir:CapabilityStatement.rest.resource.conditionalRead [ fhir:value "full-support" ];
       fhir:CapabilityStatement.rest.resource.conditionalUpdate [ fhir:value "false"^^xsd:boolean ];
       fhir:CapabilityStatement.rest.resource.conditionalDelete [ fhir:value "not-supported" ];
       fhir:CapabilityStatement.rest.resource.searchInclude [
         fhir:value "Organization";
         fhir:index 0
       ];
       fhir:CapabilityStatement.rest.resource.searchRevInclude [
         fhir:value "Person";
         fhir:index 0
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "identifier" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/Patient-identifier";

  ] ) ; # 
  fhir:software [
     fhir:name [ fhir:v "EHR" ] ;
     fhir:version [ fhir:v "0.00.020.2134" ] ;
     fhir:releaseDate [ fhir:v "2012-01-04"^^xsd:date ]
  ] ; # 
  fhir:implementation [
     fhir:description [ fhir:v "main EHR at ACME" ] ;
     fhir:url [ fhir:v "http://10.2.3.4/fhir"^^xsd:anyURI ]
  ] ; # 
  fhir:fhirVersion [ fhir:v "5.0.0"] ; # 
  fhir:format ( [ fhir:v "xml"] [ fhir:v "json"] ) ; # 
  fhir:patchFormat ( [ fhir:v "application/xml-patch+xml"] [ fhir:v "application/json-patch+json"] ) ; # 
  fhir:acceptLanguage ( [ fhir:v "en"] [ fhir:v "es"] ) ; # 
  fhir:implementationGuide ( [
     fhir:v "http://example.org/fhir/us/lab"^^xsd:anyURI ;
     fhir:link <http://example.org/fhir/us/lab>
  ] ) ; # 
  fhir:rest ( [
     fhir:mode [ fhir:v "server" ] ;
     fhir:documentation [ fhir:v "Main FHIR endpoint for acem health" ] ;
     fhir:security [
       fhir:cors [ fhir:v "true"^^xsd:boolean ] ;
       fhir:service ( [
         fhir:coding ( [
           fhir:system [ fhir:v "http://hl7.org/fhir/restful-security-service"^^xsd:anyURI ] ;
           fhir:code [ fhir:v "SMART-on-FHIR" ]
         ] )
       ] ) ;
       fhir:description [ fhir:v "See Smart on FHIR documentation" ]
     ] ;
     fhir:resource ( [
       fhir:type [ fhir:v "Patient" ] ;
       fhir:profile [
         fhir:v "http://registry.fhir.org/r5/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416"^^xsd:anyURI ;
         fhir:link <http://registry.fhir.org/r5/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416>
       ] ;
       fhir:supportedProfile ( [
         fhir:v "http://registry.fhir.org/r5/StructureDefinition/00ab9e7a-06c7-4f77-9234-4154ca1e3347"^^xsd:anyURI ;
         fhir:link <http://registry.fhir.org/r5/StructureDefinition/00ab9e7a-06c7-4f77-9234-4154ca1e3347>
       ] ) ;
       fhir:documentation [ fhir:v "This server does not let the clients create identities." ] ;
       fhir:interaction ( [
         fhir:code [ fhir:v "read" ]
       ] [
         fhir:code [ fhir:v "vread" ] ;
         fhir:documentation [ fhir:v "Only supported for patient records since 12-Dec 2012" ]
       ] [
         fhir:code [ fhir:v "update" ]
       ] [
         fhir:code [ fhir:v "history-instance" ]
       ] [
         fhir:code [ fhir:v "create" ]
       ] [
         fhir:code [ fhir:v "history-type" ]
       ] ) ;
       fhir:versioning [ fhir:v "versioned-update" ] ;
       fhir:readHistory [ fhir:v "true"^^xsd:boolean ] ;
       fhir:updateCreate [ fhir:v "false"^^xsd:boolean ] ;
       fhir:conditionalCreate [ fhir:v "true"^^xsd:boolean ] ;
       fhir:conditionalRead [ fhir:v "full-support" ] ;
       fhir:conditionalUpdate [ fhir:v "false"^^xsd:boolean ] ;
       fhir:conditionalPatch [ fhir:v "false"^^xsd:boolean ] ;
       fhir:conditionalDelete [ fhir:v "not-supported" ] ;
       fhir:searchInclude ( [ fhir:v "Patient:organization" ] ) ;
       fhir:searchRevInclude ( [ fhir:v "Person:patient" ] ) ;
       fhir:searchParam ( [
         fhir:name [ fhir:v "identifier" ] ;
         fhir:definition [
           fhir:v "http://hl7.org/fhir/SearchParameter/Patient-identifier"^^xsd:anyURI ;

           fhir:link <http://hl7.org/fhir/SearchParameter/Patient-identifier>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
         fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Only supports search by institution MRN" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "general-practitioner" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner";

         ] ;
         fhir:type [ fhir:v "token" ] ;
         fhir:documentation [ fhir:v "Only supports search by institution MRN" ]
       ] [
         fhir:name [ fhir:v "general-practitioner" ] ;
         fhir:definition [
           fhir:v "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner"^^xsd:anyURI ;

           fhir:link <http://hl7.org/fhir/SearchParameter/Patient-general-practitioner>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ]
       ]
     ];
     fhir:CapabilityStatement.rest.interaction [
       fhir:index 0;
       fhir:CapabilityStatement.rest.interaction.code [ fhir:value "transaction" ]
     ], [
       fhir:index 1;
       fhir:CapabilityStatement.rest.interaction.code [ fhir:value "history-system" ]
     ];
     fhir:CapabilityStatement.rest.compartment [
       fhir:value "http://hl7.org/fhir/CompartmentDefinition/patient";
       fhir:index 0;

         ] ;
         fhir:type [ fhir:v "reference" ]
       ] )
     ] ) ;
     fhir:interaction ( [
       fhir:code [ fhir:v "transaction" ]
     ] [
       fhir:code [ fhir:v "history-system" ]
     ] ) ;
     fhir:compartment ( [
       fhir:v "http://hl7.org/fhir/CompartmentDefinition/patient"^^xsd:anyURI ;

       fhir:link <http://hl7.org/fhir/CompartmentDefinition/patient>
     ]
  ];
  fhir:CapabilityStatement.messaging [
     fhir:index 0;
     fhir:CapabilityStatement.messaging.endpoint [
       fhir:index 0;
       fhir:CapabilityStatement.messaging.endpoint.protocol [
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/message-transport" ];
         fhir:Coding.code [ fhir:value "mllp" ]
       ];
       fhir:CapabilityStatement.messaging.endpoint.address [ fhir:value "mllp:10.1.1.10:9234" ]
     ];
     fhir:CapabilityStatement.messaging.reliableCache [ fhir:value "30"^^xsd:nonNegativeInteger ];
     fhir:CapabilityStatement.messaging.documentation [ fhir:value "ADT A08 equivalent for external system notifications" ];
     fhir:CapabilityStatement.messaging.supportedMessage [
       fhir:index 0;
       fhir:CapabilityStatement.messaging.supportedMessage.mode [ fhir:value "receiver" ];
       fhir:CapabilityStatement.messaging.supportedMessage.definition [
         fhir:value "MessageDefinition/example";

     ] )
  ] ) ; # 
  fhir:messaging ( [
     fhir:endpoint ( [
       fhir:protocol [
         fhir:system [ fhir:v "http://hl7.org/fhir/message-transport"^^xsd:anyURI ] ;
         fhir:code [ fhir:v "mllp" ]
       ] ;
       fhir:address [ fhir:v "mllp:10.1.1.10:9234"^^xsd:anyURI ]
     ] ) ;
     fhir:reliableCache [ fhir:v "30"^^xsd:nonNegativeInteger ] ;
     fhir:documentation [ fhir:v "ADT A08 equivalent for external system notifications" ] ;
     fhir:supportedMessage ( [
       fhir:mode [ fhir:v "receiver" ] ;
       fhir:definition [
         fhir:v "http://hl7.org/fhir/MessageDefinition/example"^^xsd:anyURI ;

         fhir:link <http://hl7.org/fhir/MessageDefinition/example>
       ]
     ]
  ];
  fhir:CapabilityStatement.document [
     fhir:index 0;
     fhir:CapabilityStatement.document.mode [ fhir:value "consumer" ];
     fhir:CapabilityStatement.document.documentation [ fhir:value "Basic rules for all documents in the EHR system" ];
     fhir:CapabilityStatement.document.profile [
       fhir:value "http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796";

     ] )
  ] ) ; # 
  fhir:document ( [
     fhir:mode [ fhir:v "consumer" ] ;
     fhir:documentation [ fhir:v "Basic rules for all documents in the EHR system" ] ;
     fhir:profile [
       fhir:v "http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796"^^xsd:anyURI ;

       fhir:link <http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796>
     ]
  ] .

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

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

  ] )] . # 


# -------------------------------------------------------------------------------------

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.