Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Extension: episodeOfCare

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.

Context of Use: Use on Element ID AdverseEvent, Element ID Appointment, Element ID Basic, Element ID CarePlan, Element ID ClinicalImpression, Element ID Communication, Element ID CommunicationRequest, Element ID Composition, Element ID Condition, Element ID Consent, Element ID DetectedIssue, Element ID DeviceRequest, Element ID DeviceUsage, Element ID DiagnosticReport, Element ID DocumentReference, Element ID Encounter, Element ID EnrollmentRequest, Element ID EnrollmentResponse, Element ID FamilyMemberHistory, Element ID Flag, Element ID Goal, Element ID ImagingStudy, Element ID Immunization, Element ID ImmunizationEvaluation, Element ID ImmunizationRecommendation, Element ID Invoice, Element ID List, Element ID MeasureReport, Element ID MedicationAdministration, Element ID MedicationDispense, Element ID MedicationRequest, Element ID MedicationUsage, Element ID MolecularSequence, Element ID NutritionIntake, Element ID NutritionOrder, Element ID Observation, Element ID Procedure, Element ID QuestionnaireResponse, Element ID RequestGroup, Element ID ResearchSubject, Element ID RiskAssessment, Element ID SupplyDelivery, Element ID SupplyRequest, Element ID VisionPrescription or Element ID ServiceRequest

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. episodeOfCare0..*Reference(EpisodeOfCare)URL = http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
episodeOfCare: Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.


Use on Element ID AdverseEvent, Element ID Appointment, Element ID Basic, Element ID CarePlan, Element ID ClinicalImpression, Element ID Communication, Element ID CommunicationRequest, Element ID Composition, Element ID Condition, Element ID Consent, Element ID DetectedIssue, Element ID DeviceRequest, Element ID DeviceUsage, Element ID DiagnosticReport, Element ID DocumentReference, Element ID Encounter, Element ID EnrollmentRequest, Element ID EnrollmentResponse, Element ID FamilyMemberHistory, Element ID Flag, Element ID Goal, Element ID ImagingStudy, Element ID Immunization, Element ID ImmunizationEvaluation, Element ID ImmunizationRecommendation, Element ID Invoice, Element ID List, Element ID MeasureReport, Element ID MedicationAdministration, Element ID MedicationDispense, Element ID MedicationRequest, Element ID MedicationUsage, Element ID MolecularSequence, Element ID NutritionIntake, Element ID NutritionOrder, Element ID Observation, Element ID Procedure, Element ID QuestionnaireResponse, Element ID RequestGroup, Element ID ResearchSubject, Element ID RiskAssessment, Element ID SupplyDelivery, Element ID SupplyRequest, Element ID VisionPrescription or Element ID ServiceRequest

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
episodeOfCare: Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.


Use on Element ID AdverseEvent, Element ID Appointment, Element ID Basic, Element ID CarePlan, Element ID ClinicalImpression, Element ID Communication, Element ID CommunicationRequest, Element ID Composition, Element ID Condition, Element ID Consent, Element ID DetectedIssue, Element ID DeviceRequest, Element ID DeviceUsage, Element ID DiagnosticReport, Element ID DocumentReference, Element ID Encounter, Element ID EnrollmentRequest, Element ID EnrollmentResponse, Element ID FamilyMemberHistory, Element ID Flag, Element ID Goal, Element ID ImagingStudy, Element ID Immunization, Element ID ImmunizationEvaluation, Element ID ImmunizationRecommendation, Element ID Invoice, Element ID List, Element ID MeasureReport, Element ID MedicationAdministration, Element ID MedicationDispense, Element ID MedicationRequest, Element ID MedicationUsage, Element ID MolecularSequence, Element ID NutritionIntake, Element ID NutritionOrder, Element ID Observation, Element ID Procedure, Element ID QuestionnaireResponse, Element ID RequestGroup, Element ID ResearchSubject, Element ID RiskAssessment, Element ID SupplyDelivery, Element ID SupplyRequest, Element ID VisionPrescription or Element ID ServiceRequest
... Slices for extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare"
... value[x] 1..1Reference(EpisodeOfCare)Value of extension

doco Documentation for this format

XML Template

<!-- episodeOfCare -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" >
  <!-- from Element: extension -->
 <valueReference><!-- ?? 1..1 Reference(EpisodeOfCare) Value of extension --></valueReference>
</extension>

JSON Template

{ // episodeOfCare
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", // R! 
    "valueReference" : { Reference(EpisodeOfCare) } // C? R! Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. episodeOfCare0..*Reference(EpisodeOfCare)URL = http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
episodeOfCare: Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.


Use on Element ID AdverseEvent, Element ID Appointment, Element ID Basic, Element ID CarePlan, Element ID ClinicalImpression, Element ID Communication, Element ID CommunicationRequest, Element ID Composition, Element ID Condition, Element ID Consent, Element ID DetectedIssue, Element ID DeviceRequest, Element ID DeviceUsage, Element ID DiagnosticReport, Element ID DocumentReference, Element ID Encounter, Element ID EnrollmentRequest, Element ID EnrollmentResponse, Element ID FamilyMemberHistory, Element ID Flag, Element ID Goal, Element ID ImagingStudy, Element ID Immunization, Element ID ImmunizationEvaluation, Element ID ImmunizationRecommendation, Element ID Invoice, Element ID List, Element ID MeasureReport, Element ID MedicationAdministration, Element ID MedicationDispense, Element ID MedicationRequest, Element ID MedicationUsage, Element ID MolecularSequence, Element ID NutritionIntake, Element ID NutritionOrder, Element ID Observation, Element ID Procedure, Element ID QuestionnaireResponse, Element ID RequestGroup, Element ID ResearchSubject, Element ID RiskAssessment, Element ID SupplyDelivery, Element ID SupplyRequest, Element ID VisionPrescription or Element ID ServiceRequest

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
episodeOfCare: Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.


Use on Element ID AdverseEvent, Element ID Appointment, Element ID Basic, Element ID CarePlan, Element ID ClinicalImpression, Element ID Communication, Element ID CommunicationRequest, Element ID Composition, Element ID Condition, Element ID Consent, Element ID DetectedIssue, Element ID DeviceRequest, Element ID DeviceUsage, Element ID DiagnosticReport, Element ID DocumentReference, Element ID Encounter, Element ID EnrollmentRequest, Element ID EnrollmentResponse, Element ID FamilyMemberHistory, Element ID Flag, Element ID Goal, Element ID ImagingStudy, Element ID Immunization, Element ID ImmunizationEvaluation, Element ID ImmunizationRecommendation, Element ID Invoice, Element ID List, Element ID MeasureReport, Element ID MedicationAdministration, Element ID MedicationDispense, Element ID MedicationRequest, Element ID MedicationUsage, Element ID MolecularSequence, Element ID NutritionIntake, Element ID NutritionOrder, Element ID Observation, Element ID Procedure, Element ID QuestionnaireResponse, Element ID RequestGroup, Element ID ResearchSubject, Element ID RiskAssessment, Element ID SupplyDelivery, Element ID SupplyRequest, Element ID VisionPrescription or Element ID ServiceRequest
... Slices for extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare"
... value[x] 1..1Reference(EpisodeOfCare)Value of extension

doco Documentation for this format

XML Template

<!-- episodeOfCare -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" >
  <!-- from Element: extension -->
 <valueReference><!-- ?? 1..1 Reference(EpisodeOfCare) Value of extension --></valueReference>
</extension>

JSON Template

{ // episodeOfCare
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", // R! 
    "valueReference" : { Reference(EpisodeOfCare) } // C? R! Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)