Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Extension: siteRecruitment

Biomedical Research and Regulation Work Group Maturity Level: 0InformativeUse Context: Any

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. siteRecruitment0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment
siteRecruitment: Target and actual numbers of sites for a study.


Use on Element ID ResearchStudy
... targetNumber0..1unsignedIntThe desired number of sites.

... actualNumber0..1unsignedIntThe actual number of sites.

... eligibility0..1markdownCriteria for inclusion or exclusion of sites.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment
siteRecruitment: Target and actual numbers of sites for a study.


Use on Element ID ResearchStudy
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:targetNumber 0..1ExtensionThe desired number of sites
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"targetNumber"
.... value[x] 1..1unsignedIntValue of extension
... extension:actualNumber 0..1ExtensionThe actual number of sites
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"actualNumber"
.... value[x] 1..1unsignedIntValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"eligibility"
.... value[x] 1..1markdownValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- siteRecruitment -->doco

<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

NameFlagsCard.TypeDescription & Constraintsdoco
.. siteRecruitment0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment
siteRecruitment: Target and actual numbers of sites for a study.


Use on Element ID ResearchStudy
... targetNumber0..1unsignedIntThe desired number of sites.

... actualNumber0..1unsignedIntThe actual number of sites.

... eligibility0..1markdownCriteria for inclusion or exclusion of sites.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-siteRecruitment
siteRecruitment: Target and actual numbers of sites for a study.


Use on Element ID ResearchStudy
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:targetNumber 0..1ExtensionThe desired number of sites
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"targetNumber"
.... value[x] 1..1unsignedIntValue of extension
... extension:actualNumber 0..1ExtensionThe actual number of sites
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"actualNumber"
.... value[x] 1..1unsignedIntValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"eligibility"
.... value[x] 1..1markdownValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- siteRecruitment -->doco

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