FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) 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: R4B R4 R3 R4 R3

Extension: candidateList

Orders and Observations Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/task-candidateList

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

Identifies the individuals who are candidates for being the owner of the task.

Comment :

In some environments, this list might be binding (i.e. owner must be one of the listed individuals), in others it may be suggestive (i.e. preferred owner will be from this list, but business processes may allow assignment to someone not on the list.

Context of Use: Use on element: Element ID Task

usage info: insert a list of places where this extension is used

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension candidateList 0..* Reference ( Device ), Reference ( | Organization ), Reference ( | Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) URL = http://hl7.org/fhir/StructureDefinition/task-candidateList
candidateList: Identifies the individuals who are candidates for being the owner of the task.


Use on element: Element ID Task

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/task-candidateList
candidateList: Identifies the individuals who are candidates for being the owner of the task.


Use on element: Element ID Task
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/task-candidateList" "http://hl7.org/fhir/StructureDefinition/task-candidateList"
. . . value[x] I 1..1 Reference ( Device ), Reference ( | Organization ), Reference ( | Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) Value of extension

doco Documentation for this format

XML Template 

<!-- candidateList -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/task-candidateList" >
  <!-- from Element: extension -->
 <
     Value of extension</value[x]>

 <valueReference><!-- ?? 1..1 Reference(Device) Value of extension --></valueReference>

</extension>

JSON Template 

{ // candidateList
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/task-candidateList", // R! 

    "
    "
    "
    "
    "

    "valueReference" : { Reference(Device) } // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension candidateList 0..* Reference ( Device ), Reference ( | Organization ), Reference ( | Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) URL = http://hl7.org/fhir/StructureDefinition/task-candidateList
candidateList: Identifies the individuals who are candidates for being the owner of the task.


Use on element: Element ID Task

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/task-candidateList
candidateList: Identifies the individuals who are candidates for being the owner of the task.


Use on element: Element ID Task
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/task-candidateList" "http://hl7.org/fhir/StructureDefinition/task-candidateList"
. . . value[x] I 1..1 Reference ( Device ), Reference ( | Organization ), Reference ( | Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) Value of extension

doco Documentation for this format

XML Template 

<!-- candidateList -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/task-candidateList" >
  <!-- from Element: extension -->
 <
     Value of extension</value[x]>

 <valueReference><!-- ?? 1..1 Reference(Device) Value of extension --></valueReference>

</extension>

JSON Template 

{ // candidateList
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/task-candidateList", // R! 

    "
    "
    "
    "
    "

    "valueReference" : { Reference(Device) } // 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 )