No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PORP_HD050032UV05
SPL_RMIM

(Link to Excel View)
Derived from RMIM: PORP_RM050032UV05
 
Document

Design Comments: The Structured Product Labeling document as a whole.

classCode [1..1] (M)
Document (CS) {CNE:V:ActClassDocument, root= "DOC"}

Design Comments: Fixed to DOC (document)

moodCode [1..1] (M)
Document (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN (a particular document)

id [1..1] (M)
Document (II)

Design Comments: A required, globally-unique instance identifier, which is different from the XML element identifier; see the HL7 Data Types specification for more information about use of globally-unique instance identifiers.

code [1..1] (M)
Document (CD) {CWE:D:DocumentType}

Design Comments: A code specifying the type of product labeling document (e.g., prescription drug label or over-the-counter prescription drug label). The externally-defined vocabulary domain for "Document.code" is preferentially drawn from LOINC.Some of the LOINC codes for SPL document types include: 34390-5 Human OTC Drug Label, 34391-3 Human Prescription Drug Label, 50577-6 OTC Animal Drug Label, 50578-4 Prescription Animal Drug Label, and 53404-0 Vaccine Label.

title [0..1]
Document (ED.STRUCTURED_TITLE)

Design Comments: Free text entry of the human readable title of the document. It is this title of a document that is rendered. The title describes (but does not guarantee) the content of the document.The title is either a simple string (ST) or an XML content (ED) with limited NarrativeBlock markup which allows for stylesCode, super- and sub-script, line breaks and few other functions, but explicitly excludes tables, lists, etc.

effectiveTime [1..1] (M)
Document (TS)

Design Comments: Document origination time, i.e., a timestamp specifying when the document was created.

availabilityTime [0..1]
Document (TS)

Design Comments: The release date of the product labeling document.

confidentialityCode [0..1]
Document (CD) {CWE:V:ConfidentialityByAccessKind}

Design Comments: Specifies confidentiality of the entire document. May be overriden for specific parts of the document. Values may be drawn from the Confidentiality vocabulary domain. Values other than those in the HL7 vocabulary domain (such as local codes) can also be used if necessary.

languageCode [0..1]
Document (CD) {CNE:D:HumanLanguage}

Design Comments: A code specifying the human language of character data in the product labeling document (whether in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF (Internet Engineering Task Force) RFC 3066: Tags for the Identification of Languages, ed. H. Alvestrand, 1995 (http://www.ietf.org/rfc/rfc3066.txt), which obsoletes RFC 1766. Language is a contextual component of SPL, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

setId [0..1]
Document (II)

Design Comments: An optional globally-unique identifier, that remains constant across all document revisions that derive from a common original document.

versionNumber [0..1]
Document (ST)

Design Comments: An optional version number is incremented for each subsequent version of a document. For example, an original document is the first version of a document, and gets a new globally unique "id" value; it can also contain a new value for "setId" and a value of "versionNumber" set to equal "1".

author [0..*] (Author)

Design Comments: A Participation clone that links a Document (or Section) to the Person who originated the document (or section, respectively), and, through AssignedEntity, also links to the Organization that owns the document. If desired, the author(s) of specific sections can be identified using the same structures as it is done for Document.author, which will then override the author(s) specified for the Document. (Note: In the SPL RMIM, this class is represented as a "shadow" of the author class for document, indicating that this participation is used by both the section and the document classes.

legalAuthenticator [0..*] (LegalAuthenticator)

Design Comments: In some realms there may be a requirement to capture a legal authenticator of the labeling content. A legally authenticated document exists when an individual with the proper legal authority has attested to the accuracy of the document content. A document can be legally authenticated by zero or more people. Requirements for capture of information about a potential legal authenticator have not been defined to date. However, in the case where a local document is transformed into a SPL document for exchange, authentication only occurs on the local document and the fact of authentication is reflected in the exchanged SPL document. An SPL document can reflect the unauthenticated or authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being authenticated).

verifier [0..*] (Verifier)

Design Comments: Represents reviewers, typically within the regulatory agency, where the AssignedEntity.representedOrganization provides details about the organization (e.g., the regulatory agency) for which the verifier is working. (It is possible to indicate reviewers of a different organization, such as the manufacturer itself, the representedOrganization specification will tell what level of review the Verifier participation represents.)

component [1..1] (Component3)

Design Comments: Links the "document body" to the Document.

outboundRelationship [0..*] (RelatedDocument)

Design Comments: A reference to another Document. The set of attributes in this class has the purpose of identifying the related document by identifiers only. To learn the contents of the related document, one needs to retrieve that document by the identifier(s) provided here.

 
Author

Design Comments: A Participation clone that links a Document (or Section) to the Person who originated the document (or section, respectively), and, through AssignedEntity, also links to the Organization that owns the document. If desired, the author(s) of specific sections can be identified using the same structures as it is done for Document.author, which will then override the author(s) specified for the Document. (Note: In the SPL RMIM, this class is represented as a "shadow" of the author class for document, indicating that this participation is used by both the section and the document classes.

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationAuthorOriginator, root= "AUT"}

Design Comments: The way in which a Person or Organization is participating in the document is specified by the typeCode attribute on the relevant Participation class clone. While the nature of the participation may be suggested by the XML element name, the typeCode values are the definitive indication.

contextControlCode [0..1]
Participation (CS) {CNE:V:ContextControl, default= "OP"}
noteText [0..1]
Participation (ED)

Design Comments: A comment left by the participant.

time [0..1]
Participation (TS)

Design Comments: The time of participation by the author (usually the time of origination).

signatureCode [0..1]
Participation (CD) {CNE:D:ParticipationSignature}

Design Comments: Document the existence of a signature if the value for signatureCode is "S" (for "signed"). Verification may involve signing of the document either manually or electronically by the responsible individual.

signatureText [0..1]
Participation (ED)

Design Comments: A token representing the participants electronic or digital signature.

assignedEntity2 [1..1] (R_ProductRelatedAssignedEntityUniversal)
 
LegalAuthenticator

Design Comments: In some realms there may be a requirement to capture a legal authenticator of the labeling content. A legally authenticated document exists when an individual with the proper legal authority has attested to the accuracy of the document content. A document can be legally authenticated by zero or more people. Requirements for capture of information about a potential legal authenticator have not been defined to date. However, in the case where a local document is transformed into a SPL document for exchange, authentication only occurs on the local document and the fact of authentication is reflected in the exchanged SPL document. An SPL document can reflect the unauthenticated or authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being authenticated).

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationLegalAuthenticator, root= "LA"}

Design Comments: The way in which a Person or Organization is participating in the document is specified by the typeCode attribute on the relevant Participation class clone. While the nature of the participation may be suggested by the XML element name, the typeCode values are the definitive indication.

noteText [0..1]
Participation (ED)

Design Comments: A comment left by the participant.

time [0..1]
Participation (TS)

Design Comments: The time of participation by the legal authenticator (the time at which the document was authenticated, i.e., signed).

signatureCode [0..1]
Participation (CD) {CNE:D:ParticipationSignature}

Design Comments: Document the existence of a signature if the value for signatureCode is "S" (for "signed"). Authentication involves signing of the document either manually or electronically by the responsible individual.

signatureText [0..1]
Participation (ED)

Design Comments: Represents an electronic or digital signature of the participant.

assignedEntity2 [1..1] (R_ProductRelatedAssignedEntityUniversal)
 
Verifier

Design Comments: Represents reviewers, typically within the regulatory agency, where the AssignedEntity.representedOrganization provides details about the organization (e.g., the regulatory agency) for which the verifier is working. (It is possible to indicate reviewers of a different organization, such as the manufacturer itself, the representedOrganization specification will tell what level of review the Verifier participation represents.)

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationVerifier, root= "VRF"}

Design Comments: The way in which a Person or Organization is participating in the document is specified by the typeCode attribute on the relevant Participation class clone. While the nature of the participation may be suggested by the XML element name, the typeCode values are the definitive indication.

noteText [0..1]
Participation (ED)

Design Comments: A comment left by the participant.

time [0..1]
Participation (TS)

Design Comments: Indicates the time of participation by the verifier (usually the time of review).

signatureCode [0..1]
Participation (CD) {CNE:D:ParticipationSignature}

Design Comments: Document the existence of a signature if the value for signatureCode is "S" (for "signed"). Verification may involve signing of the document either manually or electronically by the responsible individual.

signatureText [0..1]
Participation (ED)

Design Comments: Represents an electronic or digital signature of the participant.

assignedEntity2 [1..1] (R_ProductRelatedAssignedEntityUniversal)
 
Component3

Design Comments: Links the "document body" to the Document.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"}

Design Comments: Fixed to COMP (component).

contextConductionInd [0..1]
ActRelationship (BL){default= "true"}
documentBodyChoice [1..1] (DocumentBodyChoice)
 
DocumentBodyChoice
choice of NonXMLBody

Design Comments: Represents a document body that is in some format other than SPL XML (e.g., a PDF document.)

          or StructuredBody

Design Comments: Represents an XML document body that is comprised of one or more Sections.

 
NonXMLBody

Design Comments: Represents a document body that is in some format other than SPL XML (e.g., a PDF document.)

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassDocumentBody, root= "DOCBODY"}

Design Comments: Fixed to DOCBODY (document body.)

moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN.

text [1..1] (M)
Act (ED)

Design Comments: The contents of that document (as encapsulated data or reference.)

 
StructuredBody

Design Comments: Represents an XML document body that is comprised of one or more Sections.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassDocumentBody, root= "DOCBODY"}

Design Comments: Fixed to DOCBODY (document body.)

moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN.

component [0..*] (Component2)

Design Comments: Connects the top-level sections with the Document.

 
Component2

Design Comments: Connects the top-level sections with the Document.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"}

Design Comments: Fixed to COMP (component).

contextConductionInd [0..1]
ActRelationship (BL){default= "true"}
section [1..1] (Section)

Design Comments: Provides a means of organizing the product labeling content into the commonly understood sections generally found in these documents. The Section class is a container used to wrap other containers. A section element can occur in the StructuredBody, or can be nested within another Section. A section can also be replaced by another section. A section can contain nested section elements or other structures such as observations. The SPL section contains the actual product labeling text and graphics to be rendered. There are three logical components of the SPL section:General section information.Information about participants in creation of the section.The actual product labeling text and graphics to be included in the label section (and which will be rendered), along with structured data elements (that may be used for machine processing).The mechanisms to uniquely identify a specific product labeling section, to indicate a standard type code and name for the section, and to include a local name for the section (e.g. realm or language specific name; possibly constrained by the type code) are all included.Note the section element contains an optional local identifier (represented as an XML ID attribute) that can serve as the target of an XML reference.

 
Section

Design Comments: Provides a means of organizing the product labeling content into the commonly understood sections generally found in these documents. The Section class is a container used to wrap other containers. A section element can occur in the StructuredBody, or can be nested within another Section. A section can also be replaced by another section. A section can contain nested section elements or other structures such as observations. The SPL section contains the actual product labeling text and graphics to be rendered. There are three logical components of the SPL section:General section information.Information about participants in creation of the section.The actual product labeling text and graphics to be included in the label section (and which will be rendered), along with structured data elements (that may be used for machine processing).The mechanisms to uniquely identify a specific product labeling section, to indicate a standard type code and name for the section, and to include a local name for the section (e.g. realm or language specific name; possibly constrained by the type code) are all included.Note the section element contains an optional local identifier (represented as an XML ID attribute) that can serve as the target of an XML reference.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassDocumentSection, root= "DOCSECT"}

Design Comments: Fixed to DOCSECT (a document section)

moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN (a particular section)

id [1..1] (M)
Act (II)

Design Comments: A globally-unique instance identifier, which is different from the XML ID attribute; see the HL7 Data Types specification for more information about use of globally-unique instance identifiers.

code [0..1]
Act (CD) {CWE:D:DocumentSectionType}

Design Comments: A code that describes (but does not guarantee) the content of the section. The externally-defined vocabulary domain for Section.code may be drawn from LOINC. However, because the coding strength is CWE, the code set may be extended locally. Examples of possible section codes include: Indications and usage, Dosage and administration, Contraindications, Warnings, Drug interactions, Adverse reactions

title [0..1]
Act (ED.STRUCTURED_TITLE)

Design Comments: An optional free text entry of the human readable title of the section. It is the title of a section that is rendered. The title describes (but does not guarantee) the content of the section. (It is important to note that title is optional, and sections should be created for logical sub-units of the document, whether they have titles or not.)

text [0..1]
Act (ED.STRUCTURED_TEXT)

Design Comments: The attribute that holds narrative to be rendered and is a special hand-crafted content model (the same as Section.text in CDA) that is part of the SPL standard. The SPL schema incorporates by reference the NarrativeBlock schema for this content model. The content model for Section.text is defined by the Clinical Document Architecture specification (currently section 4.3.5 Section Narrative Block), to which normative reference is hereby made.While the Narrative Block schema defined by the Clinical Document Architecture is the only allowed content model for Section.text. Updates have been made to it since the last release and ballot of CDA in collaboration between the Structured Document Technical Committee and the SPL Group.The content revised attribute has an additional value of revised in addition to the existing values insert and delete. This can be used to mark text as revised without specifying in detail the nature of the change.

effectiveTime [0..1]
Act (IVL<TS>)

Design Comments: Interval of time, the lower boundary specifying the section origination time, i.e., when the section was created, the upper boundary (if any) how long the section remains in effect.

confidentialityCode [0..1]
Act (CD) {CWE:D:Confidentiality}

Design Comments: Can override the confidentialityCode attribute in Document.

languageCode [0..1]
Act (CD) {CNE:D:HumanLanguage}

Design Comments: Specifies the human language of character in the same way that Document.languageCode works. Language is a contextual component of SPL, where the value expressed in the header holds true for the entire document, unless overridden by a nested value

subject1 [0..*] (Subject3)

Design Comments: Association linking the to the Section a description of a product or substance which is the subject of that section.

Design Comments: #nosuffix

author [0..*] (Author)
replacementOf [0..*] (ReplacementOf)

Design Comments: An explicit representation of the relationships between versions of sections. Whether and how this information is used depends on the document management system in use. A replacement section replaces an existing section.

subject2 [0..*] (Subject2)

Design Comments: A relationship that links the product use guideline directly to the section [NEW: even without the highlights.]

component [0..*] (Component1)

Design Comments: Connects a section with one of its sub-sections or a multimedia component.

excerpt [0..1] (ExcerptFrom)

Design Comments: The relationship which links the Highlight to the Section which is being excerpted by the Highlight.

subjectOf [0..*] (Subject4)

Design Comments: Links a comment to a section. The section is the subject of the comment. The comment does not participate in the context of the document, i.e., is never assumed to be attributed to the document or section author and is not considered part of the document.

 
Subject3

Design Comments: Association linking the to the Section a description of a product or substance which is the subject of that section.

Design Comments: #nosuffix

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationTargetSubject, root= "SBJ"}

Design Comments: Fixed to SUBJ (subject)

subjectRole [1..1] (SubjectRole)

Design Comments: A choice between a product or substance as the subject of the description section.

 
SubjectRole

Design Comments: A choice between a product or substance as the subject of the description section.

choice of R_ProductListedUniversal
          or R_SubstanceUniversal
          or R_ProductReportableUniversal
 
ReplacementOf

Design Comments: An explicit representation of the relationships between versions of sections. Whether and how this information is used depends on the document management system in use. A replacement section replaces an existing section.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipReplaces, root= "RPLC"}

Design Comments: The value of RPLC for "replacement of" as contained in the ActRelationshipType vocabulary domain.

contextConductionInd [0..1]
ActRelationship (BL){default= "false"}
sectionReplaced [1..1] (SectionReplaced)

Design Comments: A section that is related to the section it replaces through the replacementOf relationship (an ActRelationship clone).

 
SectionReplaced

Design Comments: A section that is related to the section it replaces through the replacementOf relationship (an ActRelationship clone).

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassDocumentSection, root= "DOCSECT"}

Design Comments: Fixed to DOCSECT (a document section)

moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN (a particular section)

id [1..1] (M)
Act (II)

Design Comments: The globally unique id of the section having been so replaced.

 
Subject2

Design Comments: A relationship that links the product use guideline directly to the section [NEW: even without the highlights.]

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasSubject, root= "SUBJ"}

Design Comments: Fixet to SUBJ (subject)

substanceAdministration1 [1..1] (A_ProductUseGuidelineSPLUniversal)
 
Component1

Design Comments: Connects a section with one of its sub-sections or a multimedia component.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"}

Design Comments: Fixed to COMP (component).

contextConductionInd [0..1]
ActRelationship (BL){default= "true"}
sectionComponent [1..1] (SectionComponent)
 
SectionComponent
choice of Section

Design Comments: Provides a means of organizing the product labeling content into the commonly understood sections generally found in these documents. The Section class is a container used to wrap other containers. A section element can occur in the StructuredBody, or can be nested within another Section. A section can also be replaced by another section. A section can contain nested section elements or other structures such as observations. The SPL section contains the actual product labeling text and graphics to be rendered. There are three logical components of the SPL section:General section information.Information about participants in creation of the section.The actual product labeling text and graphics to be included in the label section (and which will be rendered), along with structured data elements (that may be used for machine processing).The mechanisms to uniquely identify a specific product labeling section, to indicate a standard type code and name for the section, and to include a local name for the section (e.g. realm or language specific name; possibly constrained by the type code) are all included.Note the section element contains an optional local identifier (represented as an XML ID attribute) that can serve as the target of an XML reference.

          or ObservationMedia

Design Comments: Holds multi-medial content, that is logically a part of a product labeling document, but may be stored outside the document and incorporated by reference. Multimedia that is integral to a document, and part of the attestable content of the document, requires the use of observationMedia. (An example might be the molecular structure for a drug in a drug product labeling document.) Multimedia that is simply referenced by the document and not an integral part of the document can use linkHtml. The XML ID attribute on the observationMedia element is used by the renderMultiMedia element (of the Narrative Block) to identify the media to be rendered.

 
ObservationMedia

Design Comments: Holds multi-medial content, that is logically a part of a product labeling document, but may be stored outside the document and incorporated by reference. Multimedia that is integral to a document, and part of the attestable content of the document, requires the use of observationMedia. (An example might be the molecular structure for a drug in a drug product labeling document.) Multimedia that is simply referenced by the document and not an integral part of the document can use linkHtml. The XML ID attribute on the observationMedia element is used by the renderMultiMedia element (of the Narrative Block) to identify the media to be rendered.

classCode [1..1] (M)
Observation (CS) {CNE:V:ActClassObservation, root= "OBS"}

Design Comments: Fixed to OBS

moodCode [1..1] (M)
Observation (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN

id [0..1]
Observation (II)

Design Comments: An optional instance identifier of the media. Note that for certain historical reasons, this may not be the identifier used to make reference to the media for the purpose of rendering it. Instead, a different attribute (ID, upper case) is used on the observationMedia element to later refer to it. It is probably a good idea to consider this id and the "ID" attribute two representations of the same id, therefore, to keep them the same.

text [0..1]
Observation (ST)

Design Comments: Used to describe the image in words suitable to the visually impaired readers.

value [1..1] (M)
Observation (ED.IMAGE)

Design Comments: Encoded data (ED) which contains the media data either inline or by reference.

 
ExcerptFrom

Design Comments: The relationship which links the Highlight to the Section which is being excerpted by the Highlight.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipExcerpt, root= "XCRPT"}

Design Comments: Fixed to XCPT (excerpt)

highlight [1..1] (Highlight)

Design Comments: An abstract or excerpt of a single topic discussed in a single section or sub-section. This abstract is presented in the form of a short text fragment as well as with structured information. The highlights are targeted at prescribers and judiciously chosen to present the most important information the prescriber needs to know in order to prescribe a medicine safely and effectively.The Highlights can be assembled to form a short abstract of the comprehensive prescribing information as a "quick reference" for the prescriber.All structured information to specify the clinical use of the drug is connected through the highlights element. The practical purpose of this construct is to focus the coding of information on the most important points guiding the appropriate use of the medicine without attempting to code nuances which would not be part of a concise summary. It also facilitates review of the structured information for correctness. Specific information structures cover the general topics: Indication, Dosage and Administration, Adverse Events, Interactions, Contraindications and other Cautions or Warnings, as well as Monitoring guidelines.

 
Highlight

Design Comments: An abstract or excerpt of a single topic discussed in a single section or sub-section. This abstract is presented in the form of a short text fragment as well as with structured information. The highlights are targeted at prescribers and judiciously chosen to present the most important information the prescriber needs to know in order to prescribe a medicine safely and effectively.The Highlights can be assembled to form a short abstract of the comprehensive prescribing information as a "quick reference" for the prescriber.All structured information to specify the clinical use of the drug is connected through the highlights element. The practical purpose of this construct is to focus the coding of information on the most important points guiding the appropriate use of the medicine without attempting to code nuances which would not be part of a concise summary. It also facilitates review of the structured information for correctness. Specific information structures cover the general topics: Indication, Dosage and Administration, Adverse Events, Interactions, Contraindications and other Cautions or Warnings, as well as Monitoring guidelines.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassDocumentSection, root= "DOCSECT"}

Design Comments: Fixed to DOCSECT (even a highlight excerpt is a document section)

moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN (a particular section)

text [0..1]
Act (ED.STRUCTURED_TEXT)

Design Comments: The text body of the highlight using structured document narrative block markup.

effectiveTime [0..1]
Act (IVL<TS>)

Design Comments: Interval of time, the lower boundary specifying when the highlight was created and the upper boundary (if any) when it ends to be effective (valid).

subject [0..*] (Subject1)

Design Comments: The relationship which links the Highlight to the product use guideline as its subject matter.

 
Subject1

Design Comments: The relationship which links the Highlight to the product use guideline as its subject matter.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasSubject, root= "SUBJ"}

Design Comments: Fixed to SUBJ (subject)

substanceAdministration1 [1..1] (A_ProductUseGuidelineSPLUniversal)
 
Subject4

Design Comments: Links a comment to a section. The section is the subject of the comment. The comment does not participate in the context of the document, i.e., is never assumed to be attributed to the document or section author and is not considered part of the document.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasSubject, root= "SUBJ"}

Design Comments: Fixed to SUBJ (subject)

comment [1..1] (Comment)

Design Comments: Editorial comments much like the comments which can be attached to text with some word processors. Comment.text contains the free text of the comment. The comment can reference a precise location in the section text using the TextFragmentReference. The following is an example:

<section>

...

<text>Pramoxicol SM is <content ID="cmt123">the cure for hair loss</content>.</text>

...

<subjectOf>

<comment>

<text>This is a unfounded hype, you need to strike this</text>

<statusCode code="active"/>

<effectiveTime .../>

<subject>

<textFragmentReference>

<text>

<reference url="#cmt123"/>

</text>

</textFragmentReference>

</subject>

</comment>

</subjectOf>

...

</section>

A comment should be attributed to an author but this author is separate from the document author (explicitly not inherited). Even if no specific author is assigned to a Comment, such Comment is not automatically attributed to the document or section author. A Comment is not even considered part of the Section; it only references the Section and can be sent along with a Section but might be stripped from the Section without such stripping being considered an alteration of the Section. Such a Comment would never be considered part of the authenticated (signed) content of the Document.

 
Comment

Design Comments: Editorial comments much like the comments which can be attached to text with some word processors. Comment.text contains the free text of the comment. The comment can reference a precise location in the section text using the TextFragmentReference. The following is an example:

<section>

...

<text>Pramoxicol SM is <content ID="cmt123">the cure for hair loss</content>.</text>

...

<subjectOf>

<comment>

<text>This is a unfounded hype, you need to strike this</text>

<statusCode code="active"/>

<effectiveTime .../>

<subject>

<textFragmentReference>

<text>

<reference url="#cmt123"/>

</text>

</textFragmentReference>

</subject>

</comment>

</subjectOf>

...

</section>

A comment should be attributed to an author but this author is separate from the document author (explicitly not inherited). Even if no specific author is assigned to a Comment, such Comment is not automatically attributed to the document or section author. A Comment is not even considered part of the Section; it only references the Section and can be sent along with a Section but might be stripped from the Section without such stripping being considered an alteration of the Section. Such a Comment would never be considered part of the authenticated (signed) content of the Document.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassRoot, root= "ACT"}
moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: 0

text [1..1] (M)
Act (ED.STRUCTURED_TEXT)

Design Comments: The free text of the comment. Uses the same Narrative Block schema as the Section.text itself.

statusCode [0..1]
Act (CS) {CNE:V:ActStatus}

Design Comments: Distinguishes comments that are open issues (active) from those that had been resolved (complete).

effectiveTime [0..1]
Act (IVL<TS>)

Design Comments: Interval of time whose lower boundary is the time the comment began to be effective (origination time) and the upper boundary (if any) when it ended to be effective (e.g., was resolved.)

author [0..*] (Author)
subject [0..*] (Subject5)

Design Comments: Allows narrowing the subject of the comment down to a specific fragment inside the Section.text.

sequel [0..*] (SequelTo)

Design Comments: Links to an earlier comment, such that one commenter can respond to another comment. When linking comments, the response to a comment is nested as a sequel/comment inside the comment element to which it responds.

<section> ... <text><content ID="cmt987" revised="delete">Pramoxicol SM is <content ID="cmt123">the cure for hair loss</content><content>.</text> ... <subjectOf> <comment> <text>O.K. you're right, we did strike the whole sentence.</text> <statusCode code="active"/> <effectiveTime .../> <subject> <textFragmentReference> <text> <reference url="#cmt987"/> </text> </textFragmentReference> </subject> <sequel> <comment> <text>This is a unfounded hype, you need to strike this</text> <statusCode code="active"/> <effectiveTime .../> <subject> <textFragmentReference> <text> <reference url="#cmt123"/> </text> </textFragmentReference> </subject> </comment> </sequel> </comment> </subjectOf> ... </section>

 
Subject5

Design Comments: Allows narrowing the subject of the comment down to a specific fragment inside the Section.text.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasSubject, root= "SUBJ"}
textFragmentReference [1..1] (TextFragmentReference)

Design Comments: References a specific fragment in the section text using the XML ID attributes on the content element in the section.

 
TextFragmentReference

Design Comments: References a specific fragment in the section text using the XML ID attributes on the content element in the section.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassRoot, root= "ACT"}
moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}
text [1..1] (M)
Act (ED.REF)

Design Comments: The reference to the text, using the referencing function of the ED data type, i.e., as a URL with a fragment reference, where the fragment is typically created by a content element with an XML ID attribute as defined in the Narrative Block schema (see Section.text).

 
SequelTo

Design Comments: Links to an earlier comment, such that one commenter can respond to another comment. When linking comments, the response to a comment is nested as a sequel/comment inside the comment element to which it responds.

<section> ... <text><content ID="cmt987" revised="delete">Pramoxicol SM is <content ID="cmt123">the cure for hair loss</content><content>.</text> ... <subjectOf> <comment> <text>O.K. you're right, we did strike the whole sentence.</text> <statusCode code="active"/> <effectiveTime .../> <subject> <textFragmentReference> <text> <reference url="#cmt987"/> </text> </textFragmentReference> </subject> <sequel> <comment> <text>This is a unfounded hype, you need to strike this</text> <statusCode code="active"/> <effectiveTime .../> <subject> <textFragmentReference> <text> <reference url="#cmt123"/> </text> </textFragmentReference> </subject> </comment> </sequel> </comment> </subjectOf> ... </section>

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipSequel, root= "SEQL"}
comment [1..1] (Comment)
 
RelatedDocument

Design Comments: A reference to another Document. The set of attributes in this class has the purpose of identifying the related document by identifiers only. To learn the contents of the related document, one needs to retrieve that document by the identifier(s) provided here.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:x_ActRelationshipDocumentSPL}

Design Comments: The nature of the relationship. For example, a replacement document replaces an existing document, where the document being replaced is referenced via this relationship with a type code of RPLC (for "replaces").

contextConductionInd [0..1]
ActRelationship (BL){default= "false"}
relatedDocument [1..1] (RelatedDocument1)

Design Comments: A reference to another Document. The set of attributes in this class has the purpose of identifying the related document by identifiers only. To learn the contents of the related document, one needs to retrieve that document by the identifier(s) provided here.

 
RelatedDocument1

Design Comments: A reference to another Document. The set of attributes in this class has the purpose of identifying the related document by identifiers only. To learn the contents of the related document, one needs to retrieve that document by the identifier(s) provided here.

classCode [1..1] (M)
Document (CS) {CNE:V:ActClassDocument, root= "DOC"}

Design Comments: One or more specific relationships between documents. These relationships rely on document identifiers described above.

moodCode [1..1] (M)
Document (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: Fixed to EVN (a particular document)

id [0..1]
Document (II)

Design Comments: Provides unambiguous explicit identification of documents and document revisions. When the RelatedDocument is used to indicate versioning, then each version has a unique document id, and the RelatedDocument.id references the previous document version.

setId [0..1]
Document (II)

Design Comments: Can be used to support conventional revision numbering in addition to the explicit links to the ancestor versions using the RelatedDocument.id. One example scenario is: The new replacement Document gets a new globally unique id value, and uses the same value for setId as the RelatedDocument being replaced, and increments the value of versionNumber. The RelatedDocument is then considered superseded, but is still retained in the system for historical reference.

versionNumber [0..1]
Document (ST)

Design Comments: Can be used to support conventional revision numbering in addition to the explicit links to the ancestor versions using the RelatedDocument.id. One example scenario is: The new replacement Document gets a new globally unique id value, and uses the same value for setId as the RelatedDocument being replaced, and increments the value of versionNumber by 1. (If used, the versionNumber will be incremented by one when a document is replaced, but can also be incremented more often to meet local requirements.) The parent document is considered superseded, but is still retained in the system for historical reference.