STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

Conformance-sdc-form-filler.ttl

Raw Turtle, JSON-LD

SDC System for completing forms

@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 xs: <http://www.w3.org/2001/XMLSchema#> .

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

<http://hl7.org/fhir//Conformance/conformance-sdc-form-filler> a fhir:Conformance;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "conformance-sdc-form-filler"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ]
  ];
  fhir:Conformance.name [ fhir:value "SDC Form Filler"];
  fhir:Conformance.status [ fhir:value "draft"];
  fhir:Conformance.date [ fhir:value "2014-07-06"^^xs:date];
  fhir:Conformance.publisher [ fhir:value "U.S. Office of the National Coordinator (ONC)"];
  fhir:Conformance.contact [
     fhir:index 0;
     fhir:Conformance.contact.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "other" ];
       fhir:ContactPoint.value [ fhir:value "http://wiki.siframework.org/Structured+Data+Capture+Initiative" ]     ]
  ];
  fhir:Conformance.description [ fhir:value "This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[sdc|Structured Data Capture FHIR implementation guide]].  This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.<br/>Note that Form Fillers may also take on the role of [[conformance-sdc-form-archiver|Form Archiver]] if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it)."];
  fhir:Conformance.kind [ fhir:value "requirements"];
  fhir:Conformance.fhirVersion [ fhir:value "1.4.0"];
  fhir:Conformance.acceptUnknown [ fhir:value "extensions"];
  fhir:Conformance.format [
     fhir:value "xml";
     fhir:index 0
  ];
  fhir:Conformance.format [
     fhir:value "json";
     fhir:index 1
  ];
  fhir:Conformance.rest [
     fhir:index 0;
     fhir:Conformance.rest.mode [ fhir:value "client" ];
     fhir:Conformance.rest.documentation [ fhir:value "The [[Questionnaire]] and [[ValueSet]] resources are retrieved to allow the system to guide the user through the entry process.  The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process.  (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.)  Finally, the [[QuestionnaireResponse]] resource is used to record the populated form." ];
     fhir:Conformance.rest.security [
       fhir:Conformance.rest.security.description [ fhir:value "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]." ]     ];
     fhir:Conformance.rest.resource [
       fhir:index 0;
       fhir:Conformance.rest.resource.type [ fhir:value "Questionnaire" ];
       fhir:Conformance.rest.resource.profile [
         fhir:reference <http://hl7.org/fhir/StructureDefinition/sdc-questionnaire>;
         fhir:Reference.reference [ fhir:value "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "search-type" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows discovery of existing questionnaires to be completed" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHOULD" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "read" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows retrieval of a specific questionnaire by id.  Allows systems to maintain a 'favorites' list of forms and retrieve them by id." ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 2;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "MAY" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "history-instance" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows review of changes made to a questionnaire over time.  Of interest to some systems, but probably not most." ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 3;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "MAY" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "vread" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows retrieval of a historical version of a questionnaire.  Most systems will make use of the current version only." ]       ]     ];
     fhir:Conformance.rest.resource [
       fhir:index 1;
       fhir:Conformance.rest.resource.type [ fhir:value "ValueSet" ];
       fhir:Conformance.rest.resource.profile [
         fhir:reference <http://hl7.org/fhir/StructureDefinition/sdc-valueset>;
         fhir:Reference.reference [ fhir:value "http://hl7.org/fhir/StructureDefinition/sdc-valueset" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "read" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows retrieval of a specific value set by id (as referenced in a Questionnaire)" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHOULD" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "vread" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 2;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "MAY" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "history-instance" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows review of changes to a value set over time.  Of interest to some systems, but probably not most." ]       ]     ];
     fhir:Conformance.rest.resource [
       fhir:index 2;
       fhir:Conformance.rest.resource.type [ fhir:value "QuestionnaireResponse" ];
       fhir:Conformance.rest.resource.profile [
         fhir:reference <http://hl7.org/fhir/StructureDefinition/sdc-element>;
         fhir:Reference.reference [ fhir:value "http://hl7.org/fhir/StructureDefinition/sdc-element" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "search-type" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows a user to search for existing completed or partially-completed forms.  Generally used to find partially-completed forms for update." ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "create" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows recording a completed or partially-completed form" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 2;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "update" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows updating an existing completed or partially-completed form.  (Systems may place rules on who can update forms and under what circumstances.)" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 3;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "delete" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows removal of a completed form from a repository.  Note that the removal may be logical rather than physical.  Some systems may have rules for who can remove a completed form and under what circumstances." ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 4;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHOULD" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "history-instance" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows review of prior versions of an answer set - allows reversion to previously recorded versions" ]       ]     ];
     fhir:Conformance.rest.resource [
       fhir:index 3;
       fhir:Conformance.rest.resource.type [ fhir:value "DocumentReference" ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHOULD" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "search-type" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows discovery of existing documents that may be included in a form pre-population request" ]       ]     ];
     fhir:Conformance.rest.resource [
       fhir:index 4;
       fhir:Conformance.rest.resource.type [ fhir:value "Binary" ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHOULD" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "read" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows retrieval of a specific binary (as pointed to by a DocumentReference)" ]       ];
       fhir:Conformance.rest.resource.interaction [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
           fhir:Extension.valueCode [ fhir:value "MAY" ]         ];
         fhir:Conformance.rest.resource.interaction.code [ fhir:value "vread" ];
         fhir:Conformance.rest.resource.interaction.documentation [ fhir:value "Allows retrieval of a historical version of a binary.  In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference." ]       ]     ];
     fhir:Conformance.rest.operation [
       fhir:index 0;
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/conformance-expectation" ];
         fhir:Extension.valueCode [ fhir:value "MAY" ]       ];
       fhir:Conformance.rest.operation.name [ fhir:value "populate" ];
       fhir:Conformance.rest.operation.definition [
         fhir:reference <http://hl7.org/fhir/OperationDefinition/questionnaire-populate>;
         fhir:Reference.reference [ fhir:value "http://hl7.org/fhir/OperationDefinition/questionnaire-populate" ];
         fhir:Reference.display [ fhir:value "Populate Questionnaire" ]       ]     ]
  ].

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


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.