Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: R4B R4

Extension: basedOn

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/event-basedOn

Version: 5.0.0-ballot

Name: basedOn

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: A plan, proposal or order that is fulfilled in whole or in part by this event.

Committee: FHIR Infrastructure Work Group

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

A plan, proposal or order that is fulfilled in whole or in part by this event.

Context of Use: Use on Element ID Condition, Element ID ChargeItem, Element ID ClinicalImpression, Element ID Composition, Element ID Consent, Element ID Coverage, Element ID DetectedIssue, Element ID DocumentManifest, Element ID EpisodeOfCare, Element ID ExplanationOfBenefit, Element ID FamilyMemberHistory, Element ID ImmunizationEvaluation, Element ID InventoryReport, Element ID MedicationUsage, Element ID PaymentNotice or Element ID PaymentReconciliation

Summary

Name	Flags	Card.	Type	Description & Constraints
basedOn		0..*	Reference(Resource)	URL = http://hl7.org/fhir/StructureDefinition/event-basedOn basedOn: A plan, proposal or order that is fulfilled in whole or in part by this event. Use on Element ID Condition, Element ID ChargeItem, Element ID ClinicalImpression, Element ID Composition, Element ID Consent, Element ID Coverage, Element ID DetectedIssue, Element ID DocumentManifest, Element ID EpisodeOfCare, Element ID ExplanationOfBenefit, Element ID FamilyMemberHistory, Element ID ImmunizationEvaluation, Element ID InventoryReport, Element ID MedicationUsage, Element ID PaymentNotice or Element ID PaymentReconciliation
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/event-basedOn basedOn: A plan, proposal or order that is fulfilled in whole or in part by this event. Use on Element ID Condition, Element ID ChargeItem, Element ID ClinicalImpression, Element ID Composition, Element ID Consent, Element ID Coverage, Element ID DetectedIssue, Element ID DocumentManifest, Element ID EpisodeOfCare, Element ID ExplanationOfBenefit, Element ID FamilyMemberHistory, Element ID ImmunizationEvaluation, Element ID InventoryReport, Element ID MedicationUsage, Element ID PaymentNotice or Element ID PaymentReconciliation
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/event-basedOn"
value[x]	1..1	Reference(Resource)	Value of extension
Documentation for this format

XML Template

<!-- basedOn -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/event-basedOn" >
  <!-- from Element: extension -->
 <valueReference><!-- I 1..1 Reference(Resource) Value of extension --></valueReference>
</extension>

JSON Template

{ // basedOn
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/event-basedOn", // R! 
    "valueReference" : { Reference(Resource) } // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
basedOn		0..*	Reference(Resource)	URL = http://hl7.org/fhir/StructureDefinition/event-basedOn basedOn: A plan, proposal or order that is fulfilled in whole or in part by this event. Use on Element ID Condition, Element ID ChargeItem, Element ID ClinicalImpression, Element ID Composition, Element ID Consent, Element ID Coverage, Element ID DetectedIssue, Element ID DocumentManifest, Element ID EpisodeOfCare, Element ID ExplanationOfBenefit, Element ID FamilyMemberHistory, Element ID ImmunizationEvaluation, Element ID InventoryReport, Element ID MedicationUsage, Element ID PaymentNotice or Element ID PaymentReconciliation
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/event-basedOn basedOn: A plan, proposal or order that is fulfilled in whole or in part by this event. Use on Element ID Condition, Element ID ChargeItem, Element ID ClinicalImpression, Element ID Composition, Element ID Consent, Element ID Coverage, Element ID DetectedIssue, Element ID DocumentManifest, Element ID EpisodeOfCare, Element ID ExplanationOfBenefit, Element ID FamilyMemberHistory, Element ID ImmunizationEvaluation, Element ID InventoryReport, Element ID MedicationUsage, Element ID PaymentNotice or Element ID PaymentReconciliation
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/event-basedOn"
value[x]	1..1	Reference(Resource)	Value of extension
Documentation for this format

XML Template

<!-- basedOn -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/event-basedOn" >
  <!-- from Element: extension -->
 <valueReference><!-- I 1..1 Reference(Resource) Value of extension --></valueReference>
</extension>

JSON Template

{ // basedOn
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/event-basedOn", // R! 
    "valueReference" : { Reference(Resource) } // I 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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.