Example CRVS Implementation Guide
0.1.0 - ci-build

Example CRVS Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: CRVS Event Profile

Official URL: http://example.org/StructureDefinition/event-profile Version: 0.1.0
Draft as of 2024-07-09 Computable Name: EventProfile

Event definition to capture CRVS events

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from EventDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition 0..* EventDefinition A description of when an event can occur
... subject[x] 0..1 CodeableConcept, Reference(Group) Type of individual the event definition is focused on
Slice: Unordered, Open by type:$this

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition C 0..* EventDefinition A description of when an event can occur
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... subject[x] 0..1 Type of individual the event definition is focused on
Slice: Unordered, Open by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... trigger Σ 1..* TriggerDefinition "when" the event occurs (multiple = 'or')

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EventDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EventDefinition.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEventDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition C 0..* EventDefinition A description of when an event can occur
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this event definition, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the event definition
... version Σ 0..1 string Business version of the event definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this event definition (computer friendly)
... title Σ 0..1 string Name for this event definition (human friendly)
... subtitle 0..1 string Subordinate title of the event definition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... subject[x] 0..1 Type of individual the event definition is focused on
Slice: Unordered, Open by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the event definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for event definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this event definition is defined
... usage 0..1 markdown Describes the clinical usage of the event definition
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate Σ 0..1 date When the event definition was approved by publisher
... lastReviewDate Σ 0..1 date When the event definition was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the event definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... trigger Σ 1..* TriggerDefinition "when" the event occurs (multiple = 'or')

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EventDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
EventDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
EventDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EventDefinition.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
EventDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
EventDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEventDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningEventDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EventDefinition

Summary

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EventDefinition.subject[x]

Differential View

This structure is derived from EventDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition 0..* EventDefinition A description of when an event can occur
... subject[x] 0..1 CodeableConcept, Reference(Group) Type of individual the event definition is focused on
Slice: Unordered, Open by type:$this

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition C 0..* EventDefinition A description of when an event can occur
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... subject[x] 0..1 Type of individual the event definition is focused on
Slice: Unordered, Open by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... trigger Σ 1..* TriggerDefinition "when" the event occurs (multiple = 'or')

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EventDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EventDefinition.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEventDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition C 0..* EventDefinition A description of when an event can occur
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this event definition, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the event definition
... version Σ 0..1 string Business version of the event definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this event definition (computer friendly)
... title Σ 0..1 string Name for this event definition (human friendly)
... subtitle 0..1 string Subordinate title of the event definition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... subject[x] 0..1 Type of individual the event definition is focused on
Slice: Unordered, Open by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the event definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for event definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this event definition is defined
... usage 0..1 markdown Describes the clinical usage of the event definition
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate Σ 0..1 date When the event definition was approved by publisher
... lastReviewDate Σ 0..1 date When the event definition was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the event definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... trigger Σ 1..* TriggerDefinition "when" the event occurs (multiple = 'or')

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EventDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
EventDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
EventDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EventDefinition.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
EventDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
EventDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEventDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningEventDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EventDefinition

Summary

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EventDefinition.subject[x]

 

Other representations of profile: CSV, Excel, Schematron