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 Procedure Entry

Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.17--20200714163558 Version: 1.0
Draft as of 2020-07-14 Computable Name: IPSProcedureEntry
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.17 (use: OFFICIAL)

The procedure entry is used to record procedures that have occurred, or which are planned for in the future.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeFixed Value: PROC
... moodCode 1..1codeBinding: MoodCodeEvnInt (required): MoodCodeEvnInt

... 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.17
... code S1..1CDBinding: Absent or Unknown Procedures (preferred): Absent or Unknown Procedures

... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CSBinding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled

... effectiveTime S1..1IVL_TS
... targetSiteCode 0..*CDBinding: IPS Target Site (preferred): IPS Target Site


... participant S1..*Participant2
.... typeCode 1..1codeFixed Value: DEV
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeFixed Value: MANU
..... id S0..*II
..... playingDevice S1..1Device
...... classCode 1..1codeFixed Value: DEV
...... determinerCode 1..1codeFixed Value: INSTANCE
...... code S1..1CEBinding: Absent or Unknown Devices (preferred): Absent or Unknown Devices

... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C0..*IPSEntryInternalReferenceBase for all types and resources
entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
..... typeCode 1..1codeFixed Value: COMP
..... inversionInd 1..1booleanFixed Value: true

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.moodCoderequiredMoodCodeEvnInt
Procedure.codepreferredIPSNoProceduresInfos
Procedure.statusCoderequiredActStatusActiveCompletedAbortedCancelled
Procedure.targetSiteCodepreferredIPSTargetSiteCode
Procedure.participant.participantRole.playingDevice.codepreferredIPSNoDevicesInfos

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullProcedure.entryRelationship:entryRelationship-1contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeBinding: ActClassProcedure (required)
Fixed Value: PROC
... moodCode 1..1codeBinding: MoodCodeEvnInt (required): MoodCodeEvnInt

... 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.17
... code S1..1CDBinding: Absent or Unknown Procedures (preferred): Absent or Unknown Procedures

... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CSBinding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled

... effectiveTime S1..1IVL_TS
... targetSiteCode 0..*CDBinding: IPS Target Site (preferred): IPS Target Site


... participant S1..*Participant2
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: DEV
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
Fixed Value: MANU
..... id S0..*II
..... playingDevice S1..1Device
...... classCode 1..1codeBinding: EntityClassDevice (required)
Fixed Value: DEV
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S1..1CEBinding: Absent or Unknown Devices (preferred): Absent or Unknown Devices

... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by value:profile
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:entryRelationship-1 SC0..*IPSEntryInternalReferenceBase for all types and resources
entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
..... typeCode 1..1codeFixed Value: COMP
..... inversionInd 1..1booleanFixed Value: true
..... contextConductionInd 1..1boolean

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Procedure.classCoderequiredFixed Value: PROC
Procedure.moodCoderequiredMoodCodeEvnInt
Procedure.codepreferredIPSNoProceduresInfos
Procedure.statusCoderequiredActStatusActiveCompletedAbortedCancelled
Procedure.targetSiteCodepreferredIPSTargetSiteCode
Procedure.participant.typeCoderequiredFixed Value: DEV
Procedure.participant.participantRole.classCoderequiredFixed Value: MANU
Procedure.participant.participantRole.playingDevice.classCoderequiredFixed Value: DEV
Procedure.participant.participantRole.playingDevice.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingDevice.codepreferredIPSNoDevicesInfos

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l308l22l17errorProcedure.entryRelationship:entryRelationship-1The @moodCode of the reference SHALL match the @moodCode of the referenced element
:
PD6643N3l24l308l22l19errorProcedure.entryRelationship:entryRelationship-1The root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
PD6643N3l24l308l22l21errorProcedure.entryRelationship:entryRelationship-1The code of the reference SHALL match the code of the referenced element
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
entryRelationship-1nullProcedure.entryRelationship:entryRelationship-1contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
:
proc-er-1errorProcedure.entryRelationship, Procedure.entryRelationship:entryRelationship-1Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeBinding: ActClassProcedure (required)
Fixed Value: PROC
... moodCode 1..1codeBinding: MoodCodeEvnInt (required): MoodCodeEvnInt

... 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.17
..... extension 0..1string
... id S0..*II
... code S1..1CDBinding: Absent or Unknown Procedures (preferred): Absent or Unknown Procedures

... negationInd 0..1boolean
... text S0..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 S1..1TEL
..... 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 S1..1CSBinding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled

... effectiveTime S1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... methodCode 0..*CE
... approachSiteCode 0..*CD
... targetSiteCode 0..*CDBinding: IPS Target Site (preferred): IPS Target Site


... 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..*Author
... 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 S1..*Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: DEV
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
Fixed Value: MANU
..... templateId 0..*II
..... id S0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice S1..1Device
...... classCode 1..1codeBinding: EntityClassDevice (required)
Fixed Value: DEV
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code S1..1CEBinding: Absent or Unknown Devices (preferred): Absent or Unknown Devices

...... manufacturerModelName 0..1SC​Binding: http://terminology.hl7.org/ValueSet/v3-ManufacturerModelName (extensible)
...... softwareName 0..1SC​Binding: http://terminology.hl7.org/ValueSet/v3-SoftwareName (extensible)
..... playingEntity 0..1PlayingEntity
..... scopingEntity 0..1Entity
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by value:profile
.... entryRelationship:All Slices Content/Rules for all slices
..... 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
.... entryRelationship:entryRelationship-1 SC0..*IPSEntryInternalReferenceBase for all types and resources
entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeFixed Value: COMP
..... inversionInd 1..1booleanFixed Value: true
..... 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
Procedure.classCoderequiredFixed Value: PROC
Procedure.moodCoderequiredMoodCodeEvnInt
Procedure.templateId:primary.nullFlavorrequiredNullFlavor
Procedure.codepreferredIPSNoProceduresInfos
Procedure.text.nullFlavorrequiredNullFlavor
Procedure.text.compressionrequiredCompressionAlgorithm
Procedure.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Procedure.text.reference.nullFlavorrequiredNullFlavor
Procedure.text.reference.userequiredAddressUse
Procedure.statusCoderequiredActStatusActiveCompletedAbortedCancelled
Procedure.priorityCodeextensibleActPriority
Procedure.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Procedure.targetSiteCodepreferredIPSTargetSiteCode
Procedure.subject.typeCoderequiredFixed Value: SBJ
Procedure.subject.contextControlCoderequiredFixed Value: OP
Procedure.subject.awarenessCodeextensibleTargetAwareness
Procedure.informant.typeCoderequiredFixed Value: INF
Procedure.informant.contextControlCoderequiredFixed Value: OP
Procedure.participant.nullFlavorrequiredNullFlavor
Procedure.participant.typeCoderequiredFixed Value: DEV
Procedure.participant.contextControlCoderequiredFixed Value: OP
Procedure.participant.participantRole.classCoderequiredFixed Value: MANU
Procedure.participant.participantRole.codeextensibleRoleCode
Procedure.participant.participantRole.playingDevice.classCoderequiredFixed Value: DEV
Procedure.participant.participantRole.playingDevice.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingDevice.codepreferredIPSNoDevicesInfos
Procedure.participant.participantRole.playingDevice.manufacturerModelNameextensible​http://terminology.hl7.org/ValueSet/v3-ManufacturerModelName
Procedure.participant.participantRole.playingDevice.softwareNameextensible​http://terminology.hl7.org/ValueSet/v3-SoftwareName

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l308l22l17errorProcedure.entryRelationship:entryRelationship-1The @moodCode of the reference SHALL match the @moodCode of the referenced element
:
PD6643N3l24l308l22l19errorProcedure.entryRelationship:entryRelationship-1The root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
PD6643N3l24l308l22l21errorProcedure.entryRelationship:entryRelationship-1The code of the reference SHALL match the code of the referenced element
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
entryRelationship-1nullProcedure.entryRelationship:entryRelationship-1contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
:
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
proc-er-1errorProcedure.entryRelationship, Procedure.entryRelationship:entryRelationship-1Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Procedure

Summary

Mandatory: 15 elements (4 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from CDAR2.Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeFixed Value: PROC
... moodCode 1..1codeBinding: MoodCodeEvnInt (required): MoodCodeEvnInt

... 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.17
... code S1..1CDBinding: Absent or Unknown Procedures (preferred): Absent or Unknown Procedures

... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CSBinding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled

... effectiveTime S1..1IVL_TS
... targetSiteCode 0..*CDBinding: IPS Target Site (preferred): IPS Target Site


... participant S1..*Participant2
.... typeCode 1..1codeFixed Value: DEV
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeFixed Value: MANU
..... id S0..*II
..... playingDevice S1..1Device
...... classCode 1..1codeFixed Value: DEV
...... determinerCode 1..1codeFixed Value: INSTANCE
...... code S1..1CEBinding: Absent or Unknown Devices (preferred): Absent or Unknown Devices

... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C0..*IPSEntryInternalReferenceBase for all types and resources
entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
..... typeCode 1..1codeFixed Value: COMP
..... inversionInd 1..1booleanFixed Value: true

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.moodCoderequiredMoodCodeEvnInt
Procedure.codepreferredIPSNoProceduresInfos
Procedure.statusCoderequiredActStatusActiveCompletedAbortedCancelled
Procedure.targetSiteCodepreferredIPSTargetSiteCode
Procedure.participant.participantRole.playingDevice.codepreferredIPSNoDevicesInfos

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullProcedure.entryRelationship:entryRelationship-1contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeBinding: ActClassProcedure (required)
Fixed Value: PROC
... moodCode 1..1codeBinding: MoodCodeEvnInt (required): MoodCodeEvnInt

... 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.17
... code S1..1CDBinding: Absent or Unknown Procedures (preferred): Absent or Unknown Procedures

... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CSBinding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled

... effectiveTime S1..1IVL_TS
... targetSiteCode 0..*CDBinding: IPS Target Site (preferred): IPS Target Site


... participant S1..*Participant2
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: DEV
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
Fixed Value: MANU
..... id S0..*II
..... playingDevice S1..1Device
...... classCode 1..1codeBinding: EntityClassDevice (required)
Fixed Value: DEV
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S1..1CEBinding: Absent or Unknown Devices (preferred): Absent or Unknown Devices

... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by value:profile
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:entryRelationship-1 SC0..*IPSEntryInternalReferenceBase for all types and resources
entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
..... typeCode 1..1codeFixed Value: COMP
..... inversionInd 1..1booleanFixed Value: true
..... contextConductionInd 1..1boolean

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Procedure.classCoderequiredFixed Value: PROC
Procedure.moodCoderequiredMoodCodeEvnInt
Procedure.codepreferredIPSNoProceduresInfos
Procedure.statusCoderequiredActStatusActiveCompletedAbortedCancelled
Procedure.targetSiteCodepreferredIPSTargetSiteCode
Procedure.participant.typeCoderequiredFixed Value: DEV
Procedure.participant.participantRole.classCoderequiredFixed Value: MANU
Procedure.participant.participantRole.playingDevice.classCoderequiredFixed Value: DEV
Procedure.participant.participantRole.playingDevice.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingDevice.codepreferredIPSNoDevicesInfos

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l308l22l17errorProcedure.entryRelationship:entryRelationship-1The @moodCode of the reference SHALL match the @moodCode of the referenced element
:
PD6643N3l24l308l22l19errorProcedure.entryRelationship:entryRelationship-1The root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
PD6643N3l24l308l22l21errorProcedure.entryRelationship:entryRelationship-1The code of the reference SHALL match the code of the referenced element
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
entryRelationship-1nullProcedure.entryRelationship:entryRelationship-1contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
:
proc-er-1errorProcedure.entryRelationship, Procedure.entryRelationship:entryRelationship-1Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeBinding: ActClassProcedure (required)
Fixed Value: PROC
... moodCode 1..1codeBinding: MoodCodeEvnInt (required): MoodCodeEvnInt

... 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.17
..... extension 0..1string
... id S0..*II
... code S1..1CDBinding: Absent or Unknown Procedures (preferred): Absent or Unknown Procedures

... negationInd 0..1boolean
... text S0..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 S1..1TEL
..... 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 S1..1CSBinding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled

... effectiveTime S1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... methodCode 0..*CE
... approachSiteCode 0..*CD
... targetSiteCode 0..*CDBinding: IPS Target Site (preferred): IPS Target Site


... 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..*Author
... 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 S1..*Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: DEV
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole S1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
Fixed Value: MANU
..... templateId 0..*II
..... id S0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice S1..1Device
...... classCode 1..1codeBinding: EntityClassDevice (required)
Fixed Value: DEV
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code S1..1CEBinding: Absent or Unknown Devices (preferred): Absent or Unknown Devices

...... manufacturerModelName 0..1SC​Binding: http://terminology.hl7.org/ValueSet/v3-ManufacturerModelName (extensible)
...... softwareName 0..1SC​Binding: http://terminology.hl7.org/ValueSet/v3-SoftwareName (extensible)
..... playingEntity 0..1PlayingEntity
..... scopingEntity 0..1Entity
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by value:profile
.... entryRelationship:All Slices Content/Rules for all slices
..... 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
.... entryRelationship:entryRelationship-1 SC0..*IPSEntryInternalReferenceBase for all types and resources
entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeFixed Value: COMP
..... inversionInd 1..1booleanFixed Value: true
..... 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
Procedure.classCoderequiredFixed Value: PROC
Procedure.moodCoderequiredMoodCodeEvnInt
Procedure.templateId:primary.nullFlavorrequiredNullFlavor
Procedure.codepreferredIPSNoProceduresInfos
Procedure.text.nullFlavorrequiredNullFlavor
Procedure.text.compressionrequiredCompressionAlgorithm
Procedure.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Procedure.text.reference.nullFlavorrequiredNullFlavor
Procedure.text.reference.userequiredAddressUse
Procedure.statusCoderequiredActStatusActiveCompletedAbortedCancelled
Procedure.priorityCodeextensibleActPriority
Procedure.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Procedure.targetSiteCodepreferredIPSTargetSiteCode
Procedure.subject.typeCoderequiredFixed Value: SBJ
Procedure.subject.contextControlCoderequiredFixed Value: OP
Procedure.subject.awarenessCodeextensibleTargetAwareness
Procedure.informant.typeCoderequiredFixed Value: INF
Procedure.informant.contextControlCoderequiredFixed Value: OP
Procedure.participant.nullFlavorrequiredNullFlavor
Procedure.participant.typeCoderequiredFixed Value: DEV
Procedure.participant.contextControlCoderequiredFixed Value: OP
Procedure.participant.participantRole.classCoderequiredFixed Value: MANU
Procedure.participant.participantRole.codeextensibleRoleCode
Procedure.participant.participantRole.playingDevice.classCoderequiredFixed Value: DEV
Procedure.participant.participantRole.playingDevice.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingDevice.codepreferredIPSNoDevicesInfos
Procedure.participant.participantRole.playingDevice.manufacturerModelNameextensible​http://terminology.hl7.org/ValueSet/v3-ManufacturerModelName
Procedure.participant.participantRole.playingDevice.softwareNameextensible​http://terminology.hl7.org/ValueSet/v3-SoftwareName

Constraints

IdGradePath(s)DetailsRequirements
PD6643N3l24l308l22l17errorProcedure.entryRelationship:entryRelationship-1The @moodCode of the reference SHALL match the @moodCode of the referenced element
:
PD6643N3l24l308l22l19errorProcedure.entryRelationship:entryRelationship-1The root and extension attributes SHALL identify an element defined elsewhere in the same document.
:
PD6643N3l24l308l22l21errorProcedure.entryRelationship:entryRelationship-1The code of the reference SHALL match the code of the referenced element
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
entryRelationship-1nullProcedure.entryRelationship:entryRelationship-1contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02.html)
:
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
proc-er-1errorProcedure.entryRelationship, Procedure.entryRelationship:entryRelationship-1Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Procedure

Summary

Mandatory: 15 elements (4 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron