This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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: R5 R4B R4 R3
ShEx statement for activitydefinition
PREFIX fhir: <http://hl7.org/fhir/> PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/> PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> BASE <http://hl7.org/fhir/shape/> start=<ActivityDefinition> AND {fhir:nodeRole [fhir:treeRoot]} # The definition of a specific activity to be taken, independent of any particular patient or context <ActivityDefinition> CLOSED { a [fhir:ActivityDefinition]; fhir:nodeRole [fhir:treeRoot]?; fhir:Resource.id @<id>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:DomainResource.text @<Narrative>?; # Text summary of the resource, for # human interpretation fhir:DomainResource.contained @<Resource>*; # Contained, inline Resources fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:ActivityDefinition.url @<uri>?; # Logical URL to reference this asset fhir:ActivityDefinition.identifier @<Identifier>*; # Logical identifier(s) for the asset fhir:ActivityDefinition.version @<string>?; # The version of the asset, if any fhir:ActivityDefinition.name @<string>?; # A machine-friendly name for the # asset fhir:ActivityDefinition.title @<string>?; # A user-friendly title for the asset fhir:ActivityDefinition.status @<code> AND {fhir:value @fhirvs:module-metadata-status}; # draft | active | inactive fhir:ActivityDefinition.experimental @<boolean>?; # If for testing purposes, not real # usage fhir:ActivityDefinition.description @<string>?; # Natural language description of # the asset fhir:ActivityDefinition.purpose @<string>?; # Describes the purpose of the asset fhir:ActivityDefinition.usage @<string>?; # Describes the clinical usage of # the asset fhir:ActivityDefinition.publicationDate @<date>?; # Publication date for this version # of the asset fhir:ActivityDefinition.lastReviewDate @<date>?; # Last review date for the asset fhir:ActivityDefinition.effectivePeriod @<Period>?; # The effective date range for the # asset fhir:ActivityDefinition.coverage @<UsageContext>*; # Describes the context of use for # this asset fhir:ActivityDefinition.topic @<CodeableConcept>*; # Descriptional topics for the asset fhir:ActivityDefinition.contributor @<Contributor>*; # A content contributor fhir:ActivityDefinition.publisher @<string>?; # Name of the publisher # (Organization or individual) fhir:ActivityDefinition.contact @<ContactDetail>*; # Contact details of the publisher fhir:ActivityDefinition.copyright @<string>?; # Use and/or publishing restrictions fhir:ActivityDefinition.relatedResource @<RelatedResource>*; # Related resources for the asset fhir:ActivityDefinition.library @<LibraryReference>*; # Logic used by the asset fhir:ActivityDefinition.category @<code> AND {fhir:value @fhirvs:activity-definition-category}?; # communication | device | # diagnostic | diet | drug | # encounter | immunization | # observation | procedure | referral # | supply | vision | other fhir:ActivityDefinition.code @<CodeableConcept>?; # Detail type of activity ( # When activity is to occur fhir:ActivityDefinition.timingCodeableConcept @<CodeableConcept> | fhir:ActivityDefinition.timingTiming @<Timing> )?; fhir:ActivityDefinition.location @<LocationReference>?; # Where it should happen fhir:ActivityDefinition.participantType @<code> AND {fhir:value @fhirvs:action-participant-type}*; # patient | practitioner | # related-person ( # What's administered/supplied fhir:ActivityDefinition.productReference @<MedicationReference> | fhir:ActivityDefinition.productReference @<SubstanceReference> | fhir:ActivityDefinition.productCodeableConcept @<CodeableConcept> )?; fhir:ActivityDefinition.quantity @<SimpleQuantity>?; # How much is # administered/consumed/supplied fhir:ActivityDefinition.transform @<StructureMapReference>?; # Transform to apply the template fhir:ActivityDefinition.dynamicValue @<ActivityDefinition.dynamicValue>*; # Dynamic aspects of the definition fhir:index xsd:integer? # Relative position in a list } # Dynamic aspects of the definition <ActivityDefinition.dynamicValue> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:ActivityDefinition.dynamicValue.description @<string>?; # Natural language description of # the dynamic value fhir:ActivityDefinition.dynamicValue.path @<string>?; # The path to the element to be set # dynamically fhir:ActivityDefinition.dynamicValue.language @<string>?; # Language of the expression fhir:ActivityDefinition.dynamicValue.expression @<string>?; # An expression that provides the # dynamic value for the # customization fhir:index xsd:integer? # Relative position in a list } #---------------------- Data Types ------------------- # Primitive Type date <date> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date?; # Primitive value for date fhir:index xsd:integer? # Relative position in a list } # Metadata about a resource <Meta> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Meta.versionId @<id>?; # Version specific identifier fhir:Meta.lastUpdated @<instant>?; # When the resource version last # changed fhir:Meta.profile @<uri>*; # Profiles this resource claims to # conform to fhir:Meta.security @<Coding>*; # Security Labels applied to this # resource fhir:Meta.tag @<Coding>*; # Tags applied to this resource fhir:index xsd:integer? # Relative position in a list } # Related resources for the module <RelatedResource> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:RelatedResource.type @<code> AND {fhir:value @fhirvs:related-resource-type}; # documentation | justification | # citation | predecessor | successor # | derived-from | depends-on | # composed-of fhir:RelatedResource.display @<string>?; # Brief description of the related # resource fhir:RelatedResource.citation @<string>?; # Bibliographic citation for the # resource fhir:RelatedResource.url @<uri>?; # Url for the related resource fhir:RelatedResource.document @<Attachment>?; # The related document fhir:RelatedResource.resource @<ResourceReference>?; # The related resource fhir:index xsd:integer? # Relative position in a list } # Primitive Type code <code> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for code fhir:index xsd:integer? # Relative position in a list } # Primitive Type string <string> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string MAXLENGTH 1048576?; # Primitive value for string fhir:index xsd:integer? # Relative position in a list } # Base Resource <Resource> {a .+; fhir:Resource.id @<id>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:index xsd:integer? } # A fixed quantity (no comparator) <SimpleQuantity> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Time range defined by start and end date/time <Period> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Period.start @<dateTime>?; # Starting time with inclusive # boundary fhir:Period.end @<dateTime>?; # End time with inclusive boundary, # if not ongoing fhir:index xsd:integer? # Relative position in a list } # Contributor information <Contributor> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Contributor.type @<code> AND {fhir:value @fhirvs:contributor-type}; # author | editor | reviewer | # endorser fhir:Contributor.name @<string>; # Name of the contributor fhir:Contributor.contact @<ContactDetail>*; # Contact details of the contributor fhir:index xsd:integer? # Relative position in a list } # Primitive Type uri <uri> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for uri fhir:index xsd:integer? # Relative position in a list } <Extension> {fhir:extension @<Extension>*; fhir:index xsd:integer? } # Contact information <ContactDetail> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:ContactDetail.name @<string>?; # Name of an individual to contact fhir:ContactDetail.telecom @<ContactPoint>*; # Contact details for individual or # organization fhir:index xsd:integer? # Relative position in a list } # An identifier intended for computation <Identifier> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Identifier.use @<code> AND {fhir:value @fhirvs:identifier-use}?; # usual | official | temp | # secondary (If known) fhir:Identifier.type @<CodeableConcept>?; # Description of identifier fhir:Identifier.system @<uri>?; # The namespace for the identifier fhir:Identifier.value @<string>?; # The value that is unique fhir:Identifier.period @<Period>?; # Time period when id is/was valid # for use fhir:Identifier.assigner @<OrganizationReference>?; # Organization that issued id (may # be just text) fhir:index xsd:integer? # Relative position in a list } # Primitive Type boolean <boolean> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:boolean?; # Primitive value for boolean fhir:index xsd:integer? # Relative position in a list } # A human-readable formatted text, including images <Narrative> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Narrative.status @<code> AND {fhir:value @fhirvs:narrative-status}; # generated | extensions | # additional | empty fhir:Narrative.div xsd:string; # Limited xhtml content fhir:index xsd:integer? # Relative position in a list } # Describes the context of use for a module <UsageContext> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:UsageContext.patientGender @<CodeableConcept>*; # Patient gender fhir:UsageContext.patientAgeGroup @<CodeableConcept>*; # Demographic category fhir:UsageContext.clinicalFocus @<CodeableConcept>*; # Clinical concepts addressed fhir:UsageContext.targetUser @<CodeableConcept>*; # Target user type fhir:UsageContext.workflowSetting @<CodeableConcept>*; # Workflow setting fhir:UsageContext.workflowTask @<CodeableConcept>*; # Clinical task context fhir:UsageContext.clinicalVenue @<CodeableConcept>*; # Applicable venue fhir:UsageContext.jurisdiction @<CodeableConcept>*; # Intended jurisdiction fhir:index xsd:integer? # Relative position in a list } # Primitive Type id <id> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for id fhir:index xsd:integer? # Relative position in a list } # A timing schedule that specifies an event that may occur multiple times <Timing> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Timing.event @<dateTime>*; # When the event occurs fhir:Timing.repeat @<Timing.repeat>?; # When the event is to occur fhir:Timing.code @<CodeableConcept>?; # BID | TID | QID | AM | PM | QD | # QOD | Q4H | Q6H + fhir:index xsd:integer? # Relative position in a list } # Concept - reference to a terminology or just text <CodeableConcept> CLOSED { fhir:concept IRI*; fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:CodeableConcept.coding @<Coding>*; # Code defined by a terminology # system fhir:CodeableConcept.text @<string>?; # Plain text representation of the # concept fhir:index xsd:integer? # Relative position in a list } # Primitive Type dateTime <dateTime> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime?; # Primitive value for dateTime fhir:index xsd:integer? # Relative position in a list } # Content in a format defined elsewhere <Attachment> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Attachment.contentType @<code>?; # Mime type of the content, with # charset etc. fhir:Attachment.language @<code>?; # Human language of the content # (BCP-47) fhir:Attachment.data @<base64Binary>?; # Data inline, base64ed fhir:Attachment.url @<uri>?; # Uri where the data can be found fhir:Attachment.size @<unsignedInt>?; # Number of bytes of content (if url # provided) fhir:Attachment.hash @<base64Binary>?; # Hash of the data (sha-1, base64ed) fhir:Attachment.title @<string>?; # Label to display in place of the # data fhir:Attachment.creation @<dateTime>?; # Date attachment was first created fhir:index xsd:integer? # Relative position in a list } # Primitive Type instant <instant> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:dateTime?; # Primitive value for instant fhir:index xsd:integer? # Relative position in a list } # Details of a Technology mediated contact point (phone, fax, email, etc.) <ContactPoint> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:ContactPoint.system @<code> AND {fhir:value @fhirvs:contact-point-system}?; # phone | fax | email | pager | other fhir:ContactPoint.value @<string>?; # The actual contact point details fhir:ContactPoint.use @<code> AND {fhir:value @fhirvs:contact-point-use}?; # home | work | temp | old | mobile # - purpose of this contact point fhir:ContactPoint.rank @<positiveInt>?; # Specify preferred order of use (1 # = highest) fhir:ContactPoint.period @<Period>?; # Time period when the contact point # was/is in use fhir:index xsd:integer? # Relative position in a list } # A reference to a code defined by a terminology system <Coding> CLOSED { fhir:concept IRI?; fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Coding.system @<uri>?; # Identity of the terminology system fhir:Coding.version @<string>?; # Version of the system - if relevant fhir:Coding.code @<code>?; # Symbol in syntax defined by the # system fhir:Coding.display @<string>?; # Representation defined by the # system fhir:Coding.userSelected @<boolean>?; # If this coding was chosen directly # by the user fhir:index xsd:integer? # Relative position in a list } # Primitive Type decimal <decimal> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:decimal?; # Primitive value for decimal fhir:index xsd:integer? # Relative position in a list } # Primitive Type positiveInt <positiveInt> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:positiveInteger?; # Primitive value for positiveInt fhir:index xsd:integer? # Relative position in a list } # Primitive Type base64Binary <base64Binary> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:base64Binary?; # Primitive value for base64Binary fhir:index xsd:integer? # Relative position in a list } # Primitive Type unsignedInt <unsignedInt> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:nonNegativeInteger?; # Primitive value for unsignedInt fhir:index xsd:integer? # Relative position in a list } # When the event is to occur <Timing.repeat> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations ( # Length/Range of lengths, or (Start # and/or end) limits fhir:Timing.repeat.boundsDuration @<Duration> | fhir:Timing.repeat.boundsRange @<Range> | fhir:Timing.repeat.boundsPeriod @<Period> )?; fhir:Timing.repeat.count @<integer>?; # Number of times to repeat fhir:Timing.repeat.countMax @<integer>?; # Maximum number of times to repeat fhir:Timing.repeat.duration @<decimal>?; # How long when it happens fhir:Timing.repeat.durationMax @<decimal>?; # How long when it happens (Max) fhir:Timing.repeat.durationUnit @<code> AND {fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a - # unit of time (UCUM) fhir:Timing.repeat.frequency @<integer>?; # Event occurs frequency times per # period fhir:Timing.repeat.frequencyMax @<integer>?; # Event occurs up to frequencyMax # times per period fhir:Timing.repeat.period @<decimal>?; # Event occurs frequency times per # period fhir:Timing.repeat.periodMax @<decimal>?; # Upper limit of period (3-4 hours) fhir:Timing.repeat.periodUnit @<code> AND {fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a - # unit of time (UCUM) fhir:Timing.repeat.when @<code> AND {fhir:value @fhirvs:event-timing}?; # Regular life events the event is # tied to fhir:Timing.repeat.offset @<unsignedInt>?; # Minutes from event (before or # after) fhir:index xsd:integer? # Relative position in a list } # Primitive Type integer <integer> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:int MININCLUSIVE "-2147483648"^^xsd:int MAXINCLUSIVE "2147483647"^^xsd:int?; # Primitive value for integer fhir:index xsd:integer? # Relative position in a list } # A length of time <Duration> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Quantity.value @<decimal>?; # Numerical value (with implicit # precision) fhir:Quantity.comparator @<code> AND {fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to # understand the value fhir:Quantity.unit @<string>?; # Unit representation fhir:Quantity.system @<uri>?; # System that defines coded unit form fhir:Quantity.code @<code>?; # Coded form of the unit fhir:index xsd:integer? # Relative position in a list } # Set of values bounded by low and high <Range> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Range.low @<SimpleQuantity>?; # Low limit fhir:Range.high @<SimpleQuantity>?; # High limit fhir:index xsd:integer? # Relative position in a list } #---------------------- Reference Types ------------------- <StructureMapReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<StructureMap> OR CLOSED {a fhir:StructureMap}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <OrganizationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Organization> OR CLOSED {a fhir:Organization}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <MedicationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Medication> OR CLOSED {a fhir:Medication}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <ResourceReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Resource> OR CLOSED {a fhir:Resource}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <SubstanceReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Substance> OR CLOSED {a fhir:Substance}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <LibraryReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Library> OR CLOSED {a fhir:Library}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <LocationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Location> OR CLOSED {a fhir:Location}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } #---------------------- Value Sets ------------------------ # The type of participant for the action @fhirvs:action-participant-type = ["patient" "practitioner" "related-person"] # High-level categorization of the type of activity in a protocol. @fhirvs:activity-definition-category = ["communication" "device" "diagnostic" "diet" "drug" "encounter" "immunization" "observation" "procedure" "referral" "supply" "vision" "other"] # A unit of time (units from UCUM). @fhirvs:units-of-time = ["s" "min" "h" "d" "wk" "mo" "a"] # Use of contact point @fhirvs:contact-point-use = ["home" "work" "temp" "old" "mobile"] # The status of the knowledge asset @fhirvs:module-metadata-status = ["draft" "active" "inactive"] # Real world event that the relating to the schedule. @fhirvs:event-timing = ["HS" "WAKE" "C" "CM" "CD" "CV" "AC" "ACM" "ACD" "ACV" "PC" "PCM" "PCD" "PCV"] # Telecommunications form for contact point @fhirvs:contact-point-system = ["phone" "fax" "email" "pager" "other"] # The status of a resource narrative @fhirvs:narrative-status = ["generated" "extensions" "additional" "empty"] # How the Quantity should be understood and represented. @fhirvs:quantity-comparator = ["<" "<=" ">=" ">"] # The type of contributor @fhirvs:contributor-type = ["author" "editor" "reviewer" "endorser"] # The type of related resource for the module @fhirvs:related-resource-type = ["documentation" "justification" "citation" "predecessor" "successor" "derived-from" "depends-on" "composed-of"] # Identifies the purpose for this identifier, if known . @fhirvs:identifier-use = ["usual" "official" "temp" "secondary"]
Usage note: every effort has been made to ensure that the ShEx files are correct and useful, but they are not a normative part of the specification.