• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: siteRecruitment

URL for this extension:

http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment

Status: draft. Extension maintained by: HL7

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.

Context of Use: Use on Element ID ResearchStudy

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
siteRecruitment		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment siteRecruitment: 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	Criteria for inclusion or exclusion of sites.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment siteRecruitment: Target and actual numbers of sites for a study. Use on Element ID ResearchStudy
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	string	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	string	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	string	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
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- siteRecruitment -->

<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">  0..1 Extension  <!--  0..1 The desired number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="actualNumber">  0..1 Extension  <!--  0..1 The actual number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="eligibility">  0..1 Extension  <!--  0..1 Inclusion and exclusion criteria -->
  <valueMarkdown value="[markdown]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // siteRecruitment
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The desired number of sites // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // C? R! Value of extension
      },
      { // The actual number of sites // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "actualNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // C? R! Value of extension
      },
      { // Inclusion and exclusion criteria // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "eligibility", // R! 
        "valueMarkdown" : "<markdown>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
siteRecruitment		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment siteRecruitment: 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	Criteria for inclusion or exclusion of sites.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment siteRecruitment: Target and actual numbers of sites for a study. Use on Element ID ResearchStudy
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	string	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	string	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	string	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
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- siteRecruitment -->

<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">  0..1 Extension  <!--  0..1 The desired number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="actualNumber">  0..1 Extension  <!--  0..1 The actual number of sites -->
  <valueUnsignedInt value="[unsignedInt]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="eligibility">  0..1 Extension  <!--  0..1 Inclusion and exclusion criteria -->
  <valueMarkdown value="[markdown]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // siteRecruitment
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The desired number of sites // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // C? R! Value of extension
      },
      { // The actual number of sites // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "actualNumber", // R! 
        "valueUnsignedInt" : "<unsignedInt>" // C? R! Value of extension
      },
      { // Inclusion and exclusion criteria // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "eligibility", // R! 
        "valueMarkdown" : "<markdown>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 
// value[x]: Value of extension. One of these 51:
  }

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.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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• 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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• 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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)