electronic Case Reporting (eCR) Implementation Guide: STU2 Ballot

This page is part of the electronic Case Reporting (eCR) (v0.2.0: STU 1 Ballot 2) based on FHIR R3. 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-knowledge-distribution-valueset-library

eCR Profile: knowledge-distribution-valueset-library

Scope and Usage

Defines the library containing the Reportable Condition Trigger Code value sets. These are used in Public Health as trigger codes to kick off creation of electronic initial case reports and reportability responses.

Additional Profile specific implementation guidance:

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/knowledge-distribution-valueset-library

Published on Sun Aug 19 00:00:00 AEST 2018 as a draft by .

This profile builds on Library

Summary

Mandatory: 33 elements
Must-Support: 25 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Library.relatedArtifact is sliced based on the value of value:display

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library S0..*
... identifier S1..1Identifier
.... system S1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value S1..1stringThe OID for the RCTC ValueSet Library
... version S1..1stringThe version of the RCTC ValueSet Library.
... name S1..1string
... title S1..1string
... status S1..1code
... type S1..1CodeableConceptasset-collection
.... coding 1..1Coding
..... system 1..1uriFixed Value: http://hl7.org/fhir/ValueSet/library-type
..... code 1..1codeFixed Value: asset-collection
... description 1..1markdownRequired Pattern: Triggers for initiating decision support for electronic case reports
... effectivePeriod S1..1Period
.... start S1..1dateTime
... relatedArtifact RelatedArtifactSlice: Unordered, Open by value:display
... relatedArtifact S1..1RelatedArtifactDiagnosis Problem Value Set
.... type 1..1codecomposed-of
Required Pattern: composed-of
.... display 1..1stringRequired Pattern: Diagnosis Problem Triggers for Public Health Reporting
.... resource S1..1Reference(Resource)
..... reference S1..1string
... relatedArtifact S1..1RelatedArtifactOrganism Substance Value Set
.... type 1..1codecomposed-of
Required Pattern: composed-of
.... display 1..1stringRequired Pattern: Organism Substance Triggers for Public Health Reporting
.... resource S1..1Reference(Resource)
..... reference S1..1string
... relatedArtifact S1..1RelatedArtifactLab Order Test Value Set
.... type 1..1codecomposed-of
Required Pattern: composed-of
.... display 1..1stringRequired Pattern: Lab Order Test Name Triggers for Public Health Reporting
.... resource S1..1Reference(Resource)
..... reference S1..1string
... relatedArtifact S1..1RelatedArtifactLab Observation Test Value Set
.... type 1..1codecomposed-of
Required Pattern: composed-of
.... display 1..1stringRequired Pattern: Lab Obs Test Name Triggers for Public Health Reporting
.... resource S1..1Reference(Resource)
..... reference S1..1string
... relatedArtifact S1..1RelatedArtifactDrugs Prescribed Value Set
.... type 1..1codecomposed-of
Required Pattern: composed-of
.... display 1..1stringRequired Pattern: Drugs Prescribed Triggers for Public Health Reporting
.... resource S1..1Reference(Resource)
..... reference S1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library SI0..*Represents a library of quality improvement components
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this library (globally unique)
... identifier SΣ1..1IdentifierAdditional identifier for the library
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for Object Identifiers
Required Pattern: urn:ietf:rfc:3986
.... value SΣ1..1stringThe OID for the RCTC ValueSet Library
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version SΣ1..1stringThe version of the RCTC ValueSet Library.
... name SΣ1..1stringName for this library (computer friendly)
... title SΣ1..1stringName for this library (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... type SΣ1..1CodeableConceptasset-collection
Binding: LibraryType (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/ValueSet/library-type
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: asset-collection
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description Σ1..1markdownNatural language description of the library
Required Pattern: Triggers for initiating decision support for electronic case reports
... purpose 0..1markdownWhy this library is defined
... usage 0..1stringDescribes the clinical usage of the library
... approvalDate 0..1dateWhen the library was approved by publisher
... lastReviewDate 0..1dateWhen the library was last reviewed
... effectivePeriod SΣ1..1PeriodWhen the library is expected to be used
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣI1..1dateTimeStarting time with inclusive boundary
.... end ΣI0..1dateTimeEnd time with inclusive boundary, if not ongoing
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact RelatedArtifactAdditional documentation, citations, etc.
Slice: Unordered, Open by value:display
... relatedArtifact S1..1RelatedArtifactDiagnosis Problem Value Set
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required)
Required Pattern: composed-of
.... display Σ1..1stringBrief description of the related artifact
Required Pattern: Diagnosis Problem Triggers for Public Health Reporting
.... citation Σ0..1stringBibliographic citation for the artifact
.... url Σ0..1uriWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource SΣ1..1Reference(Resource)What resource is being referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... relatedArtifact S1..1RelatedArtifactOrganism Substance Value Set
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required)
Required Pattern: composed-of
.... display Σ1..1stringBrief description of the related artifact
Required Pattern: Organism Substance Triggers for Public Health Reporting
.... citation Σ0..1stringBibliographic citation for the artifact
.... url Σ0..1uriWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource SΣ1..1Reference(Resource)What resource is being referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... relatedArtifact S1..1RelatedArtifactLab Order Test Value Set
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required)
Required Pattern: composed-of
.... display Σ1..1stringBrief description of the related artifact
Required Pattern: Lab Order Test Name Triggers for Public Health Reporting
.... citation Σ0..1stringBibliographic citation for the artifact
.... url Σ0..1uriWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource SΣ1..1Reference(Resource)What resource is being referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... relatedArtifact S1..1RelatedArtifactLab Observation Test Value Set
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required)
Required Pattern: composed-of
.... display Σ1..1stringBrief description of the related artifact
Required Pattern: Lab Obs Test Name Triggers for Public Health Reporting
.... citation Σ0..1stringBibliographic citation for the artifact
.... url Σ0..1uriWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource SΣ1..1Reference(Resource)What resource is being referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... relatedArtifact S1..1RelatedArtifactDrugs Prescribed Value Set
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codecomposed-of
Binding: RelatedArtifactType (required)
Required Pattern: composed-of
.... display Σ1..1stringBrief description of the related artifact
Required Pattern: Drugs Prescribed Triggers for Public Health Reporting
.... citation Σ0..1stringBibliographic citation for the artifact
.... url Σ0..1uriWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource SΣ1..1Reference(Resource)What resource is being referenced
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... parameter 0..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content 0..*AttachmentContents of the library, either embedded or referenced

doco Documentation for this format

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