Extension: ResearchStudy Site Recruitment

Biomedical Research and Regulation Work Group

Maturity Level: 0

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment`				Version: 5.0.0-snapshot3
draft as of 2021-03-31				Computable Name: RSSiteRecruitment
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1098

Context of Use: Use on Element ID ResearchStudy

Definition

Target and actual numbers of sites for a study.

Comment:

Using Group for sites in the same way as for subjects would be appropriate but would need to extend Group to allow this.

Summary

Name	Card.	Type	Description & Constraints
RSSiteRecruitment	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment RSSiteRecruitment: Target and actual numbers of sites for a study. Use on Element ID ResearchStudy
targetNumber	0..1	unsignedInt	The desired number of sites
actualNumber	0..1	unsignedInt	The actual number of sites
eligibility	0..1	markdown	Inclusion and exclusion criteria
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment RSSiteRecruitment: Target and actual numbers of sites for a study. Use on Element ID ResearchStudy
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:targetNumber	0..1	Extension	The desired number of sites
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"targetNumber"
value[x]	1..1	unsignedInt	Value of extension
extension:actualNumber	0..1	Extension	The actual number of sites
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"actualNumber"
value[x]	1..1	unsignedInt	Value of extension
extension:eligibility	0..1	Extension	Inclusion and exclusion criteria
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"eligibility"
value[x]	1..1	markdown	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
value[x]	0..0
Documentation for this format

XML Template

<!-- RSSiteRecruitment -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="targetNumber"> I 0..1 Extension  <!-- I 0..1 The desired number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="actualNumber"> I 0..1 Extension  <!-- I 0..1 The actual number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="eligibility"> I 0..1 Extension  <!-- I 0..1 Inclusion and exclusion criteria -->
  <valueMarkdown value="[markdown]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // RSSiteRecruitment
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The desired number of sites // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // I R! Value of extension
      },
      { // The actual number of sites // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "actualNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // I R! Value of extension
      },
      { // Inclusion and exclusion criteria // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "eligibility", // R! 
        "valueMarkdown" : "<markdown>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IThe desired number of sites
    "extension" : { Extension }, // IThe actual number of sites
    "extension" : { Extension }, // IInclusion and exclusion criteria
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
RSSiteRecruitment	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment RSSiteRecruitment: Target and actual numbers of sites for a study. Use on Element ID ResearchStudy
targetNumber	0..1	unsignedInt	The desired number of sites
actualNumber	0..1	unsignedInt	The actual number of sites
eligibility	0..1	markdown	Inclusion and exclusion criteria
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment RSSiteRecruitment: Target and actual numbers of sites for a study. Use on Element ID ResearchStudy
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:targetNumber	0..1	Extension	The desired number of sites
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"targetNumber"
value[x]	1..1	unsignedInt	Value of extension
extension:actualNumber	0..1	Extension	The actual number of sites
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"actualNumber"
value[x]	1..1	unsignedInt	Value of extension
extension:eligibility	0..1	Extension	Inclusion and exclusion criteria
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"eligibility"
value[x]	1..1	markdown	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
value[x]	0..0
Documentation for this format

XML Template

<!-- RSSiteRecruitment -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="targetNumber"> I 0..1 Extension  <!-- I 0..1 The desired number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="actualNumber"> I 0..1 Extension  <!-- I 0..1 The actual number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="eligibility"> I 0..1 Extension  <!-- I 0..1 Inclusion and exclusion criteria -->
  <valueMarkdown value="[markdown]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // RSSiteRecruitment
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The desired number of sites // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // I R! Value of extension
      },
      { // The actual number of sites // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "actualNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // I R! Value of extension
      },
      { // Inclusion and exclusion criteria // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "eligibility", // R! 
        "valueMarkdown" : "<markdown>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IThe desired number of sites
    "extension" : { Extension }, // IThe actual number of sites
    "extension" : { Extension }, // IInclusion and exclusion criteria
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal" // R! 
  // value[x]: Value of extension: Prohibited
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.