STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: The patient's participation in clinical trials

(No assigned work group)   Maturity Level : 0 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
The patient's participation in clinical trials: The clinical trials this patient has or is participating in.
Use on element: Patient
. . . NCT 1..1 string The National Clinical Trial number. The format for the US ClinicalTrials.gov registry number is "NCT" followed by an 8-digit number, e.g.: NCT00000419.
. . . period 0..1 Period The start and end times of the participation of this patient in the clinical trial.
. . . reason 0..1 CodeableConcept The indication or reason the patient is part of this trial.

doco Documentation for this format

Fulle Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
The patient's participation in clinical trials: The clinical trials this patient has or is participating in.
Use on element: Patient
. . . extension 1..1 Extension National Clinical Trial number
. . . . extension 0 .. 0
. . . . url 1..1 uri "NCT"
. . . . valueString 1..1 string Value of extension
. . . extension 0..1 Extension The period of participation in the clinical trial
. . . . extension 0 .. 0
. . . . url 1..1 uri "period"
. . . . valuePeriod 1..1 Period Value of extension
. . . extension 0..1 Extension The reason for participation in the clinical trial
. . . . extension 0 .. 0
. . . . url 1..1 uri "reason"
. . . . valueCodeableConcept 1..1 CodeableConcept Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- The patient's participation in clinical trials -->doco

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

JSON Template 

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

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
The patient's participation in clinical trials: The clinical trials this patient has or is participating in.
Use on element: Patient
. . . NCT 1..1 string The National Clinical Trial number. The format for the US ClinicalTrials.gov registry number is "NCT" followed by an 8-digit number, e.g.: NCT00000419.
. . . period 0..1 Period The start and end times of the participation of this patient in the clinical trial.
. . . reason 0..1 CodeableConcept The indication or reason the patient is part of this trial.

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
The patient's participation in clinical trials: The clinical trials this patient has or is participating in.
Use on element: Patient
. . . extension 1..1 Extension National Clinical Trial number
. . . . extension 0 .. 0
. . . . url 1..1 uri "NCT"
. . . . valueString 1..1 string Value of extension
. . . extension 0..1 Extension The period of participation in the clinical trial
. . . . extension 0 .. 0
. . . . url 1..1 uri "period"
. . . . valuePeriod 1..1 Period Value of extension
. . . extension 0..1 Extension The reason for participation in the clinical trial
. . . . extension 0 .. 0
. . . . url 1..1 uri "reason"
. . . . valueCodeableConcept 1..1 CodeableConcept Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- The patient's participation in clinical trials -->doco

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

JSON Template 

{ // The patient's participation in clinical trials
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // National Clinical Trial number // R! 
        // from Element: extension
        "url" : "NCT", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // The period of participation in the clinical trial //
        // from Element: extension
        "url" : "period", // R! 
        "valuePeriod" : { Period } // R! Value of extension
      },
      { // The reason for participation in the clinical trial //
        // from Element: extension
        "url" : "reason", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! 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')]) )