Health Care Surveys Content Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Healthcare Surveys Reporting Content IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

: HCS PlanDefinition Example - TTL Representation

Raw ttl | Download


@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 -------------------------------------------------------------------

 a fhir:PlanDefinition;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "plandefinition-example"];
  fhir:Resource.meta [
     fhir:Meta.versionId [ fhir:value "1" ];
     fhir:Meta.lastUpdated [ fhir:value "2020-11-29T02:03:28.045+00:00"^^xsd:dateTime ];
     fhir:Meta.profile [
       fhir:value "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition";
       fhir:index 0;
       fhir:link <http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition>     ]
  ];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>PlanDefinition Narrative</b></p><p><b>Receiver Endpoint Address</b>: <a>Generated Summary: id: example-nchs-endpoint; status: active; <span title=\"{http://terminology.hl7.org/CodeSystem/endpoint-connection-type hl7-fhir-rest}\">HL7 FHIR</span>; name: PHAReceiver; endpointmanager@example.pha.org; period: 2020-11-20 --&gt; (ongoing); <span title=\"Codes: {http://hl7.org/fhir/resource-types Bundle}\">Bundle</span>; payloadMimeType: application/fhir+xml, payloadMimeType: application/fhir+json; address: http://example.pha.org/fhir</a></p><p><b>Author Signature</b>: </p><p><b style=\"color: maroon\">Exception generating Narrative: type org.hl7.fhir.r5.model.Signature not handled - should not be here</b></p></div>"
  ];
  fhir:DomainResource.extension [
     fhir:index 0;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress" ];
     fhir:Extension.valueReference [
       fhir:Reference.reference [ fhir:value "Endpoint/example-ph-endpoint" ]     ]
  ], [
     fhir:index 1;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature" ];
     fhir:Extension.valueSignature [
       fhir:Signature.type [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "urn:iso-astm:E1762-95:2013" ];
         fhir:Coding.code [ fhir:value "1.2.840.10065.1.12.1.5" ];
         fhir:Coding.display [ fhir:value "Verification Signature" ]       ];
       fhir:Signature.when [ fhir:value "2020-11-03T22:39:24.000+00:00"^^xsd:dateTime ];
       fhir:Signature.who [
         fhir:Reference.reference [ fhir:value "Organization/example-pha-org" ]       ];
       fhir:Signature.targetFormat [ fhir:value "application/fhir+xml" ];
       fhir:Signature.sigFormat [ fhir:value "application/signature+xml" ];
       fhir:Signature.data [ fhir:value "L44u"^^xsd:base64Binary ]     ]
  ];
  fhir:PlanDefinition.url [ fhir:value "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/plandefinition-example"];
  fhir:PlanDefinition.version [ fhir:value "0.1.0"];
  fhir:PlanDefinition.name [ fhir:value "PlanDefinitionExample"];
  fhir:PlanDefinition.title [ fhir:value "PlanDefinition Example"];
  fhir:PlanDefinition.type [
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/plan-definition-type" ];
       fhir:Coding.code [ fhir:value "workflow-definition" ];
       fhir:Coding.display [ fhir:value "Workflow Definition" ]     ]
  ];
  fhir:PlanDefinition.status [ fhir:value "draft"];
  fhir:PlanDefinition.experimental [ fhir:value "true"^^xsd:boolean];
  fhir:PlanDefinition.date [ fhir:value "2020-11-04T12:32:29.858-05:00"^^xsd:dateTime];
  fhir:PlanDefinition.publisher [ fhir:value "HL7 International - Public Health Work Group"];
  fhir:PlanDefinition.contact [
     fhir:index 0;
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/Special/committees/pher" ]     ]
  ];
  fhir:PlanDefinition.description [ fhir:value "This is the Health Care Survey Reporting Knowledge Artifact"];
  fhir:PlanDefinition.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:PlanDefinition.effectivePeriod [
     fhir:Period.start [ fhir:value "2021-11-01"^^xsd:date ]
  ];
  fhir:PlanDefinition.relatedArtifact [
     fhir:index 0;
     fhir:RelatedArtifact.type [ fhir:value "depends-on" ];
     fhir:RelatedArtifact.label [ fhir:value "Health Care Survey Registered Participants" ];
     fhir:RelatedArtifact.resource [
       fhir:value "http://nchs/fhir/r4/Group/healthcare-survey-participants";
       fhir:link <http://nchs/fhir/r4/Group/healthcare-survey-participants>     ]
  ];
  fhir:PlanDefinition.action [
     fhir:index 0;
     fhir:Element.id [ fhir:value "start-workflow" ];
     fhir:PlanDefinition.action.description [ fhir:value "This action represents the start of the reporting workflow in response to the encounter-close event" ];
     fhir:PlanDefinition.action.textEquivalent [ fhir:value "Start the reporting workflow in response to an encounter-close event" ];
     fhir:PlanDefinition.action.code [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions" ];
         fhir:Coding.code [ fhir:value "initiate-reporting-workflow" ]       ]     ];
     fhir:PlanDefinition.action.trigger [
       fhir:index 0;
       fhir:Element.id [ fhir:value "encounter-close" ];
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType" ];
         fhir:Extension.valueCodeableConcept [
           fhir:CodeableConcept.coding [
             fhir:index 0;
             fhir:Coding.system [ fhir:value "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents" ];
             fhir:Coding.code [ fhir:value "encounter-close" ];
             fhir:Coding.display [ fhir:value "Indicates the close of an encounter" ]           ]         ]       ];
       fhir:TriggerDefinition.type [ fhir:value "named-event" ];
       fhir:TriggerDefinition.name [ fhir:value "encounter-close" ]     ];
     fhir:PlanDefinition.action.relatedAction [
       fhir:index 0;
       fhir:PlanDefinition.action.relatedAction.actionId [ fhir:value "check-survey-participants" ];
       fhir:PlanDefinition.action.relatedAction.relationship [ fhir:value "before-start" ];
       fhir:PlanDefinition.action.relatedAction.offsetDuration [
         fhir:Quantity.value [ fhir:value "5"^^xsd:decimal ];
         fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ];
         fhir:Quantity.code [ fhir:value "min" ]       ]     ]
  ], [
     fhir:index 1;
     fhir:Element.id [ fhir:value "check-survey-participants" ];
     fhir:PlanDefinition.action.description [ fhir:value "This action represents the check if Practitioner is registered to report on health care surveys." ];
     fhir:PlanDefinition.action.textEquivalent [ fhir:value "Check Participant Registration" ];
     fhir:PlanDefinition.action.code [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions" ];
         fhir:Coding.code [ fhir:value "check-participant-registration" ]       ]     ];
     fhir:PlanDefinition.action.condition [
       fhir:index 0;
       fhir:PlanDefinition.action.condition.kind [ fhir:value "applicability" ];
       fhir:PlanDefinition.action.condition.expression [
         fhir:Expression.language [ fhir:value "text/fhirpath" ];
         fhir:Expression.expression [ fhir:value "closedEncounter.participant.individual.identifier.where(system = 'http://hl7.org/fhir/sid/us-npi).value.subsetOf(participantGroup.member.entity.identifier.where(system = 'http://hl7.org/fhir/sid/us-npi).value)'" ]       ]     ];
     fhir:PlanDefinition.action.input [
       fhir:index 0;
       fhir:Element.id [ fhir:value "closedEncounter" ];
       fhir:DataRequirement.type [ fhir:value "Encounter" ];
       fhir:DataRequirement.profile [
         fhir:value "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter";
         fhir:index 0;
         fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter>       ]     ], [
       fhir:index 1;
       fhir:Element.id [ fhir:value "participantGroup" ];
       fhir:DataRequirement.type [ fhir:value "Group" ];
       fhir:DataRequirement.profile [
         fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-survey-practitioner-group";
         fhir:index 0;
         fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-survey-practitioner-group>       ]     ];
     fhir:PlanDefinition.action.relatedAction [
       fhir:index 0;
       fhir:PlanDefinition.action.relatedAction.actionId [ fhir:value "report-to-nchs" ];
       fhir:PlanDefinition.action.relatedAction.relationship [ fhir:value "before-start" ]     ]
  ], [
     fhir:index 2;
     fhir:Element.id [ fhir:value "report-to-nchs" ];
     fhir:PlanDefinition.action.description [ fhir:value "This action represents the creation, validation and submission of the health care survey report." ];
     fhir:PlanDefinition.action.textEquivalent [ fhir:value "Create Report and send to NCHS." ];
     fhir:PlanDefinition.action.code [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions" ];
         fhir:Coding.code [ fhir:value "execute-reporting-workflow" ]       ]     ];
     fhir:PlanDefinition.action.action [
       fhir:index 0;
       fhir:Element.id [ fhir:value "create-hcs-report" ];
       fhir:PlanDefinition.action.description [ fhir:value "This action represents the creation of the HCS Report." ];
       fhir:PlanDefinition.action.textEquivalent [ fhir:value "Health Care Survey Report" ];
       fhir:PlanDefinition.action.code [
         fhir:index 0;
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.system [ fhir:value "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions" ];
           fhir:Coding.code [ fhir:value "create-report" ]         ]       ];
       fhir:PlanDefinition.action.input [
         fhir:index 0;
         fhir:Element.id [ fhir:value "patient" ];
         fhir:DataRequirement.type [ fhir:value "Patient" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient>         ]       ], [
         fhir:index 1;
         fhir:Element.id [ fhir:value "condition" ];
         fhir:DataRequirement.type [ fhir:value "Condition" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition>         ]       ], [
         fhir:index 2;
         fhir:Element.id [ fhir:value "encounter" ];
         fhir:DataRequirement.type [ fhir:value "Encounter" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter>         ]       ], [
         fhir:index 3;
         fhir:Element.id [ fhir:value "mr" ];
         fhir:DataRequirement.type [ fhir:value "MedicationRequest" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest>         ]       ], [
         fhir:index 4;
         fhir:Element.id [ fhir:value "vitals" ];
         fhir:DataRequirement.type [ fhir:value "Observation" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/StructureDefinition/vitalsigns";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/StructureDefinition/vitalsigns>         ]       ], [
         fhir:index 5;
         fhir:Element.id [ fhir:value "labs" ];
         fhir:DataRequirement.type [ fhir:value "Observation" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab>         ]       ];
       fhir:PlanDefinition.action.output [
         fhir:index 0;
         fhir:Element.id [ fhir:value "hcs-report" ];
         fhir:DataRequirement.type [ fhir:value "Bundle" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle>         ]       ];
       fhir:PlanDefinition.action.relatedAction [
         fhir:index 0;
         fhir:PlanDefinition.action.relatedAction.actionId [ fhir:value "validate-report" ];
         fhir:PlanDefinition.action.relatedAction.relationship [ fhir:value "before-start" ]       ]     ], [
       fhir:index 1;
       fhir:Element.id [ fhir:value "validate-hcs-report" ];
       fhir:PlanDefinition.action.description [ fhir:value "This action represents the validation of the HCS Report" ];
       fhir:PlanDefinition.action.textEquivalent [ fhir:value "Validate Report" ];
       fhir:PlanDefinition.action.code [
         fhir:index 0;
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.system [ fhir:value "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions" ];
           fhir:Coding.code [ fhir:value "validate-report" ]         ]       ];
       fhir:PlanDefinition.action.input [
         fhir:index 0;
         fhir:Element.id [ fhir:value "created-hcs-report" ];
         fhir:DataRequirement.type [ fhir:value "Bundle" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle>         ]       ];
       fhir:PlanDefinition.action.output [
         fhir:index 0;
         fhir:Element.id [ fhir:value "validated-hcs-report" ];
         fhir:DataRequirement.type [ fhir:value "Bundle" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle>         ]       ];
       fhir:PlanDefinition.action.relatedAction [
         fhir:index 0;
         fhir:PlanDefinition.action.relatedAction.actionId [ fhir:value "submit-report" ];
         fhir:PlanDefinition.action.relatedAction.relationship [ fhir:value "before-start" ]       ]     ], [
       fhir:index 2;
       fhir:Element.id [ fhir:value "route-and-send-hcs-report" ];
       fhir:PlanDefinition.action.description [ fhir:value "This action represents the routing and sending of the HCS Report" ];
       fhir:PlanDefinition.action.textEquivalent [ fhir:value "Route and send HCS Report" ];
       fhir:PlanDefinition.action.code [
         fhir:index 0;
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.system [ fhir:value "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions" ];
           fhir:Coding.code [ fhir:value "submit-report" ]         ]       ];
       fhir:PlanDefinition.action.input [
         fhir:index 0;
         fhir:Element.id [ fhir:value "valid-hcs-report" ];
         fhir:DataRequirement.type [ fhir:value "Bundle" ];
         fhir:DataRequirement.profile [
           fhir:value "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle";
           fhir:index 0;
           fhir:link <http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle>         ]       ]     ]
  ].

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

 a owl:Ontology;
  owl:imports fhir:fhir.ttl.