International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPS Comment Activity

Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.22--20170405000000 Version: 1.0
Draft as of 2017-04-05 Computable Name: IPSCommentActivity
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.22 (use: OFFICIAL)

Comments are free text data that cannot otherwise be recorded using data elements already defined by this specification. They are not to be used to record information that can be recorded elsewhere. For example, a free text description of the severity of an allergic reaction would not be recorded in a comment.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 0..*CDAR2.ActBase for all types and resources
... classCode 1..1codeFixed Value: ACT
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.22
.... code 0..1stringFixed Value: 48767-8
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... text S1..1ED
.... reference SC1..1TELPD6643N3l24l260l26l14l9l10: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
..... value 1..1uri
... author 0..1Author
.... time S1..1TS
.... assignedAuthor S1..1AssignedAuthor
..... name S0..*
..... softwareName S0..1
..... id S1..1II
..... addr S1..*AD

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l260l26l14l9l10errorAct.text.referenceThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 0..*CDAR2.ActBase for all types and resources
... classCode 1..1codeFixed Value: ACT
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.22
.... code 0..1stringFixed Value: 48767-8
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... text S1..1ED
.... reference SC1..1TELPD6643N3l24l260l26l14l9l10: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
..... value 1..1uri
... author 0..1Author
.... time S1..1TS
.... assignedAuthor S1..1AssignedAuthor
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id S1..1II
..... addr S1..*AD

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l260l26l14l9l10errorAct.text.referenceThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 0..*CDAR2.ActBase for all types and resources
... classCode 1..1codeFixed Value: ACT
... moodCode 1..1codeFixed Value: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.22
..... extension 0..1string
... id 0..*II
... code S1..1CDBinding: v3 Code System ActCode (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: 48767-8
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... negationInd 0..1boolean
... text S1..1ED
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... compression 0..1codeBinding: CompressionAlgorithm (required)
.... integrityCheck 0..1base64Binary
.... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
.... language 0..1code
.... mediaType 0..1code
.... representation 0..1code
.... data[x] 0..1
..... dataStringstring
..... dataBase64Binarybase64Binary
.... reference SC1..1TELPD6643N3l24l260l26l14l9l10: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... value 1..1uri
..... useablePeriod 0..*
...... useablePeriodIVL_TS
...... useablePeriodEIVL_TS
...... useablePeriodPIVL_TS
...... useablePeriodSXPR_TS
..... use 0..*codeBinding: AddressUse (required)
.... thumbnail 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..1Author
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUT
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CE
.... time S1..1TS
.... assignedAuthor S1..1AssignedAuthor
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id S1..1II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr S1..*AD
..... telecom 0..*TEL
..... assignedPerson 0..1Person
..... assignedAuthoringDevice 0..1AuthoringDevice
..... representedOrganization 0..1Organization
... informant 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship C0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.text.nullFlavorrequiredNullFlavor
Act.text.compressionrequiredCompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.reference.nullFlavorrequiredNullFlavor
Act.text.reference.userequiredAddressUse
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.author.nullFlavorrequiredNullFlavor
Act.author.typeCoderequiredFixed Value: AUT
Act.author.contextControlCoderequiredFixed Value: OP
Act.author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
Act.author.assignedAuthor.codeextensibleRoleCode
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l260l26l14l9l10errorAct.text.referenceThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
:
act-er-1errorAct.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
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 CDAR2.Act

Summary

Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 5 elements

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 0..*CDAR2.ActBase for all types and resources
... classCode 1..1codeFixed Value: ACT
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.22
.... code 0..1stringFixed Value: 48767-8
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... text S1..1ED
.... reference SC1..1TELPD6643N3l24l260l26l14l9l10: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
..... value 1..1uri
... author 0..1Author
.... time S1..1TS
.... assignedAuthor S1..1AssignedAuthor
..... name S0..*
..... softwareName S0..1
..... id S1..1II
..... addr S1..*AD

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l260l26l14l9l10errorAct.text.referenceThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 0..*CDAR2.ActBase for all types and resources
... classCode 1..1codeFixed Value: ACT
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.22
.... code 0..1stringFixed Value: 48767-8
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... text S1..1ED
.... reference SC1..1TELPD6643N3l24l260l26l14l9l10: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
..... value 1..1uri
... author 0..1Author
.... time S1..1TS
.... assignedAuthor S1..1AssignedAuthor
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id S1..1II
..... addr S1..*AD

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l260l26l14l9l10errorAct.text.referenceThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 0..*CDAR2.ActBase for all types and resources
... classCode 1..1codeFixed Value: ACT
... moodCode 1..1codeFixed Value: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.22
..... extension 0..1string
... id 0..*II
... code S1..1CDBinding: v3 Code System ActCode (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: 48767-8
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... negationInd 0..1boolean
... text S1..1ED
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... compression 0..1codeBinding: CompressionAlgorithm (required)
.... integrityCheck 0..1base64Binary
.... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
.... language 0..1code
.... mediaType 0..1code
.... representation 0..1code
.... data[x] 0..1
..... dataStringstring
..... dataBase64Binarybase64Binary
.... reference SC1..1TELPD6643N3l24l260l26l14l9l10: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... value 1..1uri
..... useablePeriod 0..*
...... useablePeriodIVL_TS
...... useablePeriodEIVL_TS
...... useablePeriodPIVL_TS
...... useablePeriodSXPR_TS
..... use 0..*codeBinding: AddressUse (required)
.... thumbnail 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..1Author
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUT
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CE
.... time S1..1TS
.... assignedAuthor S1..1AssignedAuthor
..... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id S1..1II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr S1..*AD
..... telecom 0..*TEL
..... assignedPerson 0..1Person
..... assignedAuthoringDevice 0..1AuthoringDevice
..... representedOrganization 0..1Organization
... informant 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship C0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.text.nullFlavorrequiredNullFlavor
Act.text.compressionrequiredCompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.reference.nullFlavorrequiredNullFlavor
Act.text.reference.userequiredAddressUse
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.author.nullFlavorrequiredNullFlavor
Act.author.typeCoderequiredFixed Value: AUT
Act.author.contextControlCoderequiredFixed Value: OP
Act.author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
Act.author.assignedAuthor.codeextensibleRoleCode
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l260l26l14l9l10errorAct.text.referenceThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1.html)
:
act-er-1errorAct.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
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 CDAR2.Act

Summary

Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 10 elements
Fixed Value: 5 elements

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel, Schematron