HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm CI Build

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.39 StructureDefinition-ersd-valueset-library

Defines the library containing the eRSD value sets. These are identified by Public Health and used in EHRs in healthcare as trigger codes to kick off creation of electronic initial case reports and reportability responses.

SD.39.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-valueset-library

Published on Sun Aug 19 00:00:00 UTC 2018 as a active by HL7 Public Health Work Group.

This profile builds on Library

Summary

Mandatory: 15 elements
Must-Support: 12 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Library.relatedArtifact is sliced based on the value of profile:resource.resolve()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library S0..*Library
... identifier S1..1Identifier
.... system S1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value S1..1stringThe Value Sets RCTC OID
... version S1..1stringValue Sets RCTC Definition Definition Version
... title S1..1stringValue Sets Name
.... coding 1..1Coding
..... system 1..1uriFixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code 1..1codeFixed Value: asset-collection
... description S1..1markdownValue Sets Release Description
... purpose S1..1markdownValue Sets Purpose
... effectivePeriod S1..1Period
.... start S1..1dateTimeValue Sets Effective Start Date
... relatedArtifact 1..*(Slice Definition)Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:sliceERSDValueSet S1..*RelatedArtifacteRSD Value Set
..... type 1..1codecomposed-of
Required Pattern: composed-of
..... resource S1..1canonical(eRSD Value Set)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library SI0..*LibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣI1..1IdentifierAdditional identifier for the library
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣI1..1stringThe Value Sets RCTC OID
Example General: 123456
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... version SΣI1..1stringValue Sets RCTC Definition Definition Version
... name ΣI0..1stringName for this library (computer friendly)
... title SΣI1..1stringValue Sets Name
... subtitle I0..1stringSubordinate title of the library
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI0..1booleanFor testing purposes, not real usage
... type SΣI1..1CodeableConceptasset-collection
Binding: LibraryType (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI1..1CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
..... display ΣI0..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... subject[x] I0..1Type of individual the library content is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date ΣI0..1dateTimeDate last changed
... publisher ΣI0..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description SΣI1..1markdownValue Sets Release Description
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose SI1..1markdownValue Sets Purpose
... usage I0..1stringDescribes the clinical usage of the library
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the library was approved by publisher
... lastReviewDate I0..1dateWhen the library was last reviewed
... effectivePeriod SΣI1..1PeriodWhen the library is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣI1..1dateTimeValue Sets Effective Start Date
.... end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I1..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:sliceERSDValueSet SI1..*RelatedArtifacteRSD Value Set
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI1..1codecomposed-of
Binding: RelatedArtifactType (required)
Required Pattern: composed-of
..... label ΣI0..1stringShort label
..... display ΣI0..1stringBrief description of the related artifact
..... citation ΣI0..1markdownBibliographic citation for the artifact
..... url ΣI0..1urlWhere the artifact can be accessed
..... document ΣI0..1AttachmentWhat document is being referenced
..... resource SΣI1..1canonical(eRSD Value Set)What resource is being referenced
... parameter I0..*ParameterDefinitionParameters defined by the library
... dataRequirement I0..*DataRequirementWhat data is referenced by this library
... content ΣI0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Summary

Mandatory: 15 elements
Must-Support: 12 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Library.relatedArtifact is sliced based on the value of profile:resource.resolve()

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library S0..*Library
... identifier S1..1Identifier
.... system S1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value S1..1stringThe Value Sets RCTC OID
... version S1..1stringValue Sets RCTC Definition Definition Version
... title S1..1stringValue Sets Name
.... coding 1..1Coding
..... system 1..1uriFixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code 1..1codeFixed Value: asset-collection
... description S1..1markdownValue Sets Release Description
... purpose S1..1markdownValue Sets Purpose
... effectivePeriod S1..1Period
.... start S1..1dateTimeValue Sets Effective Start Date
... relatedArtifact 1..*(Slice Definition)Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:sliceERSDValueSet S1..*RelatedArtifacteRSD Value Set
..... type 1..1codecomposed-of
Required Pattern: composed-of
..... resource S1..1canonical(eRSD Value Set)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library SI0..*LibraryRepresents a library of quality improvement components
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this library, represented as a URI (globally unique)
... identifier SΣI1..1IdentifierAdditional identifier for the library
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣI1..1stringThe Value Sets RCTC OID
Example General: 123456
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... version SΣI1..1stringValue Sets RCTC Definition Definition Version
... name ΣI0..1stringName for this library (computer friendly)
... title SΣI1..1stringValue Sets Name
... subtitle I0..1stringSubordinate title of the library
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI0..1booleanFor testing purposes, not real usage
... type SΣI1..1CodeableConceptasset-collection
Binding: LibraryType (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI1..1CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
..... display ΣI0..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... subject[x] I0..1Type of individual the library content is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date ΣI0..1dateTimeDate last changed
... publisher ΣI0..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description SΣI1..1markdownValue Sets Release Description
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose SI1..1markdownValue Sets Purpose
... usage I0..1stringDescribes the clinical usage of the library
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the library was approved by publisher
... lastReviewDate I0..1dateWhen the library was last reviewed
... effectivePeriod SΣI1..1PeriodWhen the library is expected to be used
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣI1..1dateTimeValue Sets Effective Start Date
.... end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I1..*(Slice Definition)Additional documentation, citations, etc.
Slice: Unordered, Open by profile:resource.resolve()
.... relatedArtifact:sliceERSDValueSet SI1..*RelatedArtifacteRSD Value Set
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI1..1codecomposed-of
Binding: RelatedArtifactType (required)
Required Pattern: composed-of
..... label ΣI0..1stringShort label
..... display ΣI0..1stringBrief description of the related artifact
..... citation ΣI0..1markdownBibliographic citation for the artifact
..... url ΣI0..1urlWhere the artifact can be accessed
..... document ΣI0..1AttachmentWhat document is being referenced
..... resource SΣI1..1canonical(eRSD Value Set)What resource is being referenced
... parameter I0..*ParameterDefinitionParameters defined by the library
... dataRequirement I0..*DataRequirementWhat data is referenced by this library
... content ΣI0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron