FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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: R3 R2

Extension: clinicalTrial

Patient Administration Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial

Status: draft. Extension maintained by: HL7

The clinical trials this patient has or is participating in.

Context of Use: Use on element: Patient

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
clinicalTrial: The clinical trials this patient has or is participating in.
Use on element: Patient
... NCT1..1stringThe National Clinical Trial number. The format for the US ClinicalTrials.gov registry number is "NCT" followed by an 8-digit number, e.g.: NCT00000419.
... period0..1PeriodThe start and end times of the participation of this patient in the clinical trial.
... reason0..1CodeableConceptThe indication or reason the patient is part of this trial.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
clinicalTrial: The clinical trials this patient has or is participating in.
Use on element: Patient
... extension 1..1ExtensionNational Clinical Trial number
.... url 1..1uri"NCT"
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionThe period of participation in the clinical trial
.... url 1..1uri"period"
.... valuePeriod 0..1PeriodValue of extension
... extension 0..1ExtensionThe reason for participation in the clinical trial
.... url 1..1uri"reason"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- clinicalTrial -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="NCT"> 1..1 Extension  <!-- 1..1 National Clinical Trial number -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="period"> 0..1 Extension  <!-- 0..1 The period of participation in the clinical trial -->
  <valuePeriod><!-- 0..1 Period 
      Value of extension --></valuePeriod>
 </extension>
 <extension url="reason"> 0..1 Extension  <!-- 0..1 The reason for participation in the clinical trial -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // clinicalTrial
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // National Clinical Trial number // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "NCT", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // The period of participation in the clinical trial //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "period", // R! 
        "valuePeriod" : { Period } //Value of extension
      },
      { // The reason for participation in the clinical trial //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "reason", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
clinicalTrial: The clinical trials this patient has or is participating in.
Use on element: Patient
... NCT1..1stringThe National Clinical Trial number. The format for the US ClinicalTrials.gov registry number is "NCT" followed by an 8-digit number, e.g.: NCT00000419.
... period0..1PeriodThe start and end times of the participation of this patient in the clinical trial.
... reason0..1CodeableConceptThe indication or reason the patient is part of this trial.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
clinicalTrial: The clinical trials this patient has or is participating in.
Use on element: Patient
... extension 1..1ExtensionNational Clinical Trial number
.... url 1..1uri"NCT"
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionThe period of participation in the clinical trial
.... url 1..1uri"period"
.... valuePeriod 0..1PeriodValue of extension
... extension 0..1ExtensionThe reason for participation in the clinical trial
.... url 1..1uri"reason"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- clinicalTrial -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="NCT"> 1..1 Extension  <!-- 1..1 National Clinical Trial number -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="period"> 0..1 Extension  <!-- 0..1 The period of participation in the clinical trial -->
  <valuePeriod><!-- 0..1 Period 
      Value of extension --></valuePeriod>
 </extension>
 <extension url="reason"> 0..1 Extension  <!-- 0..1 The reason for participation in the clinical trial -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // clinicalTrial
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // National Clinical Trial number // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "NCT", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // The period of participation in the clinical trial //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "period", // R! 
        "valuePeriod" : { Period } //Value of extension
      },
      { // The reason for participation in the clinical trial //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "reason", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

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')]))