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 Specimen Collection

Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.30--20170414000000 Version: 1.0
Draft as of 2017-04-14 Computable Name: IPSSpecimenCollection
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.30 (use: OFFICIAL)

Specimen Collection is used when a set of laboratory or pathology observations  produced on one or more specimens need to be associated with the minimal characteristics of the specimen(s.html): specimen source site and type of specimen. In addition this template enables to convey when the specimen was collected. In a patient summary there is no need to provide more data than these 4:

  • collection method, 

  • source site, 

  • type of specimen and 

  • time of collection.

An occurrence of this template describes one specimen collected, used by the set of observations present in the same Result Organizer.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

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..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.30
.... code 0..1stringFixed Value: 33882-2
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... effectiveTime S0..1IVL_TS
... targetSiteCode S0..1CD
... participant S0..1Participant2
.... typeCode 1..1codeFixed Value: PRD
.... participantRole S1..1ParticipantRole
..... classCode 0..1codeFixed Value: SPEC
..... id S0..1II
..... playingEntity S1..1PlayingEntity
...... classCode 0..1codeFixed Value: ENT
...... determinerCode 0..1codeFixed Value: INSTANCE
...... code S1..1CEBinding: IPS Specimen Type (preferred): IPS Specimen Type


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.participant.participantRole.playingEntity.codepreferredIPS_SpecimenType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeBinding: ActClassProcedure (required)
Fixed Value: PROC
... 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.30
.... code 0..1stringFixed Value: 33882-2
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... effectiveTime S0..1IVL_TS
... targetSiteCode S0..1CD
... participant S0..1Participant2
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: PRD
.... participantRole S1..1ParticipantRole
..... classCode 0..1codeBinding: RoleClassRoot (required)
Fixed Value: SPEC
..... id S0..1II
..... playingEntity S1..1PlayingEntity
...... classCode 0..1codeBinding: EntityClassRoot (required)
Fixed Value: ENT
...... determinerCode 0..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S1..1CEBinding: IPS Specimen Type (preferred): IPS Specimen Type


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Procedure.classCoderequiredFixed Value: PROC
Procedure.participant.typeCoderequiredFixed Value: PRD
Procedure.participant.participantRole.classCoderequiredFixed Value: SPEC
Procedure.participant.participantRole.playingEntity.classCoderequiredFixed Value: ENT
Procedure.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingEntity.codepreferredIPS_SpecimenType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeBinding: ActClassProcedure (required)
Fixed Value: PROC
... 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.30
..... extension 0..1string
... id 0..*II
... code S0..1CD
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: 33882-2
.... 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 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime S0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... methodCode 0..*CE
... approachSiteCode 0..*CD
... targetSiteCode S0..1CD
... 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 S0..1Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: PRD
.... 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 0..1codeBinding: RoleClassRoot (required)
Fixed Value: SPEC
..... templateId 0..*II
..... id S0..1II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity S1..1PlayingEntity
...... classCode 0..1codeBinding: EntityClassRoot (required)
Fixed Value: ENT
...... determinerCode 0..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code S1..1CEBinding: IPS Specimen Type (preferred): IPS Specimen Type

...... quantity 0..*PQ
...... name 0..*EN
...... desc 0..1ED
..... scopingEntity 0..1Entity
... 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
Procedure.classCoderequiredFixed Value: PROC
Procedure.templateId:primary.nullFlavorrequiredNullFlavor
Procedure.code.nullFlavorrequiredNullFlavor
Procedure.statusCoderequiredActStatus
Procedure.priorityCodeextensibleActPriority
Procedure.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
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: PRD
Procedure.participant.contextControlCoderequiredFixed Value: OP
Procedure.participant.participantRole.classCoderequiredFixed Value: SPEC
Procedure.participant.participantRole.codeextensibleRoleCode
Procedure.participant.participantRole.playingEntity.classCoderequiredFixed Value: ENT
Procedure.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingEntity.codepreferredIPS_SpecimenType

Constraints

IdGradePath(s)DetailsRequirements
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()
proc-er-1errorProcedure.entryRelationshipOnly 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: 4 elements (4 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 9 elements

Slices

This structure defines the following Slices:

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

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..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.30
.... code 0..1stringFixed Value: 33882-2
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... effectiveTime S0..1IVL_TS
... targetSiteCode S0..1CD
... participant S0..1Participant2
.... typeCode 1..1codeFixed Value: PRD
.... participantRole S1..1ParticipantRole
..... classCode 0..1codeFixed Value: SPEC
..... id S0..1II
..... playingEntity S1..1PlayingEntity
...... classCode 0..1codeFixed Value: ENT
...... determinerCode 0..1codeFixed Value: INSTANCE
...... code S1..1CEBinding: IPS Specimen Type (preferred): IPS Specimen Type


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.participant.participantRole.playingEntity.codepreferredIPS_SpecimenType

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..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.30
.... code 0..1stringFixed Value: 33882-2
.... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
... effectiveTime S0..1IVL_TS
... targetSiteCode S0..1CD
... participant S0..1Participant2
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: PRD
.... participantRole S1..1ParticipantRole
..... classCode 0..1codeBinding: RoleClassRoot (required)
Fixed Value: SPEC
..... id S0..1II
..... playingEntity S1..1PlayingEntity
...... classCode 0..1codeBinding: EntityClassRoot (required)
Fixed Value: ENT
...... determinerCode 0..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S1..1CEBinding: IPS Specimen Type (preferred): IPS Specimen Type


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Procedure.classCoderequiredFixed Value: PROC
Procedure.participant.typeCoderequiredFixed Value: PRD
Procedure.participant.participantRole.classCoderequiredFixed Value: SPEC
Procedure.participant.participantRole.playingEntity.classCoderequiredFixed Value: ENT
Procedure.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingEntity.codepreferredIPS_SpecimenType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*CDAR2.ProcedureBase for all types and resources
... classCode 1..1codeBinding: ActClassProcedure (required)
Fixed Value: PROC
... 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.30
..... extension 0..1string
... id 0..*II
... code S0..1CD
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: 33882-2
.... 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 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime S0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... methodCode 0..*CE
... approachSiteCode 0..*CD
... targetSiteCode S0..1CD
... 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 S0..1Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Fixed Value: PRD
.... 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 0..1codeBinding: RoleClassRoot (required)
Fixed Value: SPEC
..... templateId 0..*II
..... id S0..1II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity S1..1PlayingEntity
...... classCode 0..1codeBinding: EntityClassRoot (required)
Fixed Value: ENT
...... determinerCode 0..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code S1..1CEBinding: IPS Specimen Type (preferred): IPS Specimen Type

...... quantity 0..*PQ
...... name 0..*EN
...... desc 0..1ED
..... scopingEntity 0..1Entity
... 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
Procedure.classCoderequiredFixed Value: PROC
Procedure.templateId:primary.nullFlavorrequiredNullFlavor
Procedure.code.nullFlavorrequiredNullFlavor
Procedure.statusCoderequiredActStatus
Procedure.priorityCodeextensibleActPriority
Procedure.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
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: PRD
Procedure.participant.contextControlCoderequiredFixed Value: OP
Procedure.participant.participantRole.classCoderequiredFixed Value: SPEC
Procedure.participant.participantRole.codeextensibleRoleCode
Procedure.participant.participantRole.playingEntity.classCoderequiredFixed Value: ENT
Procedure.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Procedure.participant.participantRole.playingEntity.codepreferredIPS_SpecimenType

Constraints

IdGradePath(s)DetailsRequirements
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()
proc-er-1errorProcedure.entryRelationshipOnly 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: 4 elements (4 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 9 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron