Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Operative Note

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/OperativeNote Version: 2.1
Active as of 2023-09-29 Computable Name: OperativeNote
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.1.7:2015-08-01

The Operative Note is a frequently used type of procedure note with specific requirements set forth by regulatory agencies.

The Operative Note is created immediately following a surgical or other high-risk procedure. It records the pre- and post-surgical diagnosis, pertinent events of the procedure, as well as the condition of the patient following the procedure. The report should be sufficiently detailed to support the diagnoses, justify the treatment, document the course of the procedure, and provide continuity of care.

Usage:

  • This Logical Model 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 USRealmHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalDocument 1..1USRealmHeaderXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, copyTime, recordTarget, author, dataEnterer, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, relatedDocument, authorization, componentOf, component, realmCode, typeId, templateId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, recordTarget, author, dataEnterer, informant, informant, informant, custodian, informationRecipient, legalAuthenticator, authenticator, authenticator, participant, inFulfillmentOf, documentationOf, authorization, componentOf
Base for all types and resources
... templateId 2..*II
... templateId:secondary 1..1II
.... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.7
.... extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CEThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
.... code 1..1csBinding: SurgicalOperationNoteDocumentTypeCode (required)
.... serviceEvent C1..1ServiceEvent1198-8487: The value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
..... effectiveTime C1..1USRealmDateandTimeDTUSFIELDEDBase for all types and resources
1198-8488: The serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
1198-10058: If a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
1198-10060: When only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
..... Slices for performer 1..*Performer1This performer represents any assistants.
Slice: Unordered, Open by value:assignedEntity, value:typeCode, value:functionCode
...... performer:performer1 1..*Performer1This performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
....... typeCode 1..1csFixed Value: PPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
...... performer:performer2 0..*Performer1
....... typeCode 1..1csFixed Value: SPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
... authorization 0..1AuthorizationAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
.... typeCode 1..1cs
.... consent 1..1Consent
..... classCode 1..1cs
..... moodCode 1..1cs
..... statusCode 1..1CS
... component 1..1Component
.... structuredBody 1..1StructuredBody
..... Slices for component 8..*InfrastructureRootSlice: Unordered, Open by value:ClinicalDocument.section
...... component:component1 1..1InfrastructureRoot
....... section 1..1AnesthesiaSectionBase for all types and resources
...... component:component2 1..1InfrastructureRoot
....... section 1..1ComplicationsSectionBase for all types and resources
...... component:component3 1..1InfrastructureRoot
....... section 1..1PreoperativeDiagnosisSectionBase for all types and resources
...... component:component4 1..1InfrastructureRoot
....... section 1..1ProcedureEstimatedBloodLossSectionBase for all types and resources
...... component:component5 1..1InfrastructureRoot
....... section 1..1ProcedureFindingsSectionBase for all types and resources
...... component:component6 1..1InfrastructureRoot
....... section 1..1ProcedureSpecimensTakenSectionBase for all types and resources
...... component:component7 1..1InfrastructureRoot
....... section 1..1ProcedureDescriptionSectionBase for all types and resources
...... component:component8 1..1InfrastructureRoot
....... section 1..1PostoperativeDiagnosisSectionBase for all types and resources
...... component:component9 0..1InfrastructureRoot
....... section 1..1ProcedureImplantsSectionBase for all types and resources
...... component:component10 0..1InfrastructureRoot
....... section 1..1OperativeNoteFluidsSectionBase for all types and resources
...... component:component11 0..1InfrastructureRoot
....... section 1..1OperativeNoteSurgicalProcedureSectionBase for all types and resources
...... component:component12 0..1InfrastructureRoot
....... section 1..1PlanofTreatmentSectionBase for all types and resources
...... component:component13 0..1InfrastructureRoot
....... section 1..1PlannedProcedureSectionBase for all types and resources
...... component:component14 0..1InfrastructureRoot
....... section 1..1ProcedureDispositionSectionBase for all types and resources
...... component:component15 0..1InfrastructureRoot
....... section 1..1ProcedureIndicationsSectionBase for all types and resources
...... component:component16 0..1InfrastructureRoot
....... section 1..1SurgicalDrainsSectionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ClinicalDocument.code.coderequiredSurgicalOperationNoteDocumentTypeCode
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)

Constraints

IdGradePath(s)DetailsRequirements
1198-8487errorClinicalDocument.documentationOf.serviceEventThe value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
:
1198-8488errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeThe serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
:
1198-10058errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
:
1198-10060errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeWhen only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalDocument 1..1USRealmHeaderXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, copyTime, recordTarget, author, dataEnterer, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, relatedDocument, authorization, componentOf, component, realmCode, typeId, templateId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, recordTarget, author, dataEnterer, informant, informant, informant, custodian, informationRecipient, legalAuthenticator, authenticator, authenticator, participant, inFulfillmentOf, documentationOf, authorization, componentOf
Base for all types and resources
... realmCode 1..1CS
.... @code 1..1csRequired Pattern: US
... typeId 1..1II
.... @root 1..1stFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1stExtension
Fixed Value: POCD_HD000040
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:us-realm 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.1
..... @extension 1..1stRequired Pattern: 2023-05-01
.... templateId:secondary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.7
..... @extension 1..1stRequired Pattern: 2015-08-01
... code C1..1CEThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Binding: FHIRDocumentTypeCodes (extensible)
.... @code 1..1csBinding: SurgicalOperationNoteDocumentTypeCode (required)
... title 1..1STThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
... effectiveTime C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
... confidentialityCode 1..1CEBinding: HL7 BasicConfidentialityKind (preferred)
... languageCode 1..1CSBinding: VSAC 2.16.840.1.113883.1.11.11526 (required)
... recordTarget 1..*RecordTarget
.... patientRole 1..1PatientRole
..... id 1..*II
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... patient 1..1Patient
...... name C1..*USRealmPatientNamePTNUSFIELDEDBase for all types and resources
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime C1..1TS
...... raceCode 1..1CEBinding: Race Category Excluding Nulls (required)
...... ethnicGroupCode 1..1CEBinding: Ethnicity (required)
... author 1..*Author
.... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
.... assignedAuthor C1..1AssignedAuthor
..... Slices for id 1..*IISlice: Unordered, Open by value:root
...... id:id1 0..1IIid
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
... Slices for informant 0..*InformantSlice: Unordered, Open by value:relatedEntity
.... informant:informant1 0..*Informantinformant
..... assignedEntity 1..1AssignedEntity
...... id C1..*II
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... assignedPerson 1..1Person
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
.... informant:informant2 0..*Informantinformant
..... relatedEntity 1..1RelatedEntity
... custodian 1..1Custodian
.... assignedCustodian 1..1AssignedCustodian
..... representedCustodianOrganization 1..1CustodianOrganization
...... id 1..*II
...... name 1..1ON
...... telecom 1..1TEL
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... addr C1..1USRealmAddressADUSFIELDEDBase for all types and resources
... Slices for authenticator 0..*AuthenticatorSlice: Unordered, Open by value:ClinicalDocument.signatureCode, value:ClinicalDocument.assignedEntity, value:ClinicalDocument.time
.... authenticator:authenticator1 0..*Authenticatorauthenticator
..... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
..... signatureCode 1..1CS
...... @code 1..1csRequired Pattern: S
..... assignedEntity 1..1AssignedEntity
...... id 1..*II
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 1..*TEL
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... assignedPerson 1..1Person
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
... documentationOf 1..*DocumentationOfA serviceEvent represents the main act, such as a colonoscopy or an appendectomy, being documented. A serviceEvent can further specialize the act inherent in the ClinicalDocument/code, such as where the ClinicalDocument/code is simply "Surgical Operation Note" and the procedure is "Appendectomy." serviceEvent is required in the Operative Note and it must be equivalent to or further specialize the value inherent in the ClinicalDocument/code; it shall not conflict with the value inherent in the ClinicalDocument/code, as such a conflict would create ambiguity. serviceEvent/effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place. If the date and the duration of the procedure is known, serviceEvent/effectiveTime/low is used with a width element that describes the duration; no high element is used. However, if only the date is known, the date is placed in both the low and high elements.
.... serviceEvent C1..1ServiceEvent1198-8487: The value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
..... @classCode 1..1csBinding: ActClass (required)
..... effectiveTime C1..1USRealmDateandTimeDTUSFIELDEDBase for all types and resources
1198-8488: The serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
1198-10058: If a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
1198-10060: When only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
...... low 1..1IVXB_TS
..... Slices for performer 1..*Performer1This performer represents any assistants.
Slice: Unordered, Open by value:assignedEntity, value:typeCode, value:functionCode
...... performer:All Slices Content/Rules for all slices
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
....... assignedEntity 1..1AssignedEntity
........ id 1..*II
...... performer:performer1 1..*Performer1This performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: PPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ id 1..*II
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
...... performer:performer2 0..*Performer1
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: SPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ id 1..*II
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
... authorization 0..1AuthorizationAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: AUTH
.... consent 1..1Consent
..... @classCode 1..1csBinding: ActClass (required)
Fixed Value: CONS
..... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
..... statusCode 1..1CSBinding: ActStatus (required)
...... @code 1..1csFixed Value: completed
... component 1..1Component
.... structuredBody 1..1StructuredBody
..... Slices for component 8..*InfrastructureRootSlice: Unordered, Open by value:ClinicalDocument.section
...... component:All Slices Content/Rules for all slices
....... section 1..1Section
...... component:component1 1..1InfrastructureRoot
....... section 1..1AnesthesiaSectionBase for all types and resources
...... component:component2 1..1InfrastructureRoot
....... section 1..1ComplicationsSectionBase for all types and resources
...... component:component3 1..1InfrastructureRoot
....... section 1..1PreoperativeDiagnosisSectionBase for all types and resources
...... component:component4 1..1InfrastructureRoot
....... section C1..1ProcedureEstimatedBloodLossSectionBase for all types and resources
...... component:component5 1..1InfrastructureRoot
....... section 1..1ProcedureFindingsSectionBase for all types and resources
...... component:component6 1..1InfrastructureRoot
....... section C1..1ProcedureSpecimensTakenSectionBase for all types and resources
...... component:component7 1..1InfrastructureRoot
....... section 1..1ProcedureDescriptionSectionBase for all types and resources
...... component:component8 1..1InfrastructureRoot
....... section 1..1PostoperativeDiagnosisSectionBase for all types and resources
...... component:component9 0..1InfrastructureRoot
....... section C1..1ProcedureImplantsSectionBase for all types and resources
...... component:component10 0..1InfrastructureRoot
....... section C1..1OperativeNoteFluidsSectionBase for all types and resources
...... component:component11 0..1InfrastructureRoot
....... section C1..1OperativeNoteSurgicalProcedureSectionBase for all types and resources
...... component:component12 0..1InfrastructureRoot
....... section 1..1PlanofTreatmentSectionBase for all types and resources
...... component:component13 0..1InfrastructureRoot
....... section 1..1PlannedProcedureSectionBase for all types and resources
...... component:component14 0..1InfrastructureRoot
....... section 1..1ProcedureDispositionSectionBase for all types and resources
...... component:component15 0..1InfrastructureRoot
....... section 1..1ProcedureIndicationsSectionBase for all types and resources
...... component:component16 0..1InfrastructureRoot
....... section C1..1SurgicalDrainsSectionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClinicalDocument.codeextensibleFHIRDocumentTypeCodes
ClinicalDocument.code.coderequiredSurgicalOperationNoteDocumentTypeCode
ClinicalDocument.confidentialityCodepreferredHL7 BasicConfidentialityKind
ClinicalDocument.languageCoderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526
ClinicalDocument.recordTarget.patientRole.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)
ClinicalDocument.recordTarget.patientRole.patient.raceCoderequiredRace Category Excluding Nulls
ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCoderequiredEthnicity
ClinicalDocument.author.assignedAuthor.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.documentationOf.serviceEvent.classCoderequiredActClass
ClinicalDocument.documentationOf.serviceEvent.performer.typeCoderequiredx_ServiceEventPerformer
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCoderequiredFixed Value: PPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.typeCoderequiredFixed Value: SPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.authorization.typeCoderequiredFixed Value: AUTH
ClinicalDocument.authorization.consent.classCoderequiredFixed Value: CONS
ClinicalDocument.authorization.consent.moodCoderequiredFixed Value: EVN
ClinicalDocument.authorization.consent.statusCoderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
1198-8487errorClinicalDocument.documentationOf.serviceEventThe value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
:
1198-8488errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeThe serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
:
1198-10058errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
:
1198-10060errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeWhen only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
:
4537-5299errorClinicalDocument.recordTarget.patientRole.patient.birthTime**SHALL** be precise to year (CONF:4537-5299).
:
4537-5300warningClinicalDocument.recordTarget.patientRole.patient.birthTime**SHOULD** be precise to day (CONF:4537-5300).
:
4537-9946warningClinicalDocument.informant:informant1.assignedEntity.idIf assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946).
:
4537-9991warningClinicalDocument.idThis id **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
:
4537-9992errorClinicalDocument.codeThis code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
:
4537-16790errorClinicalDocument.author.assignedAuthorThere **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790).
:
4537-32418warningClinicalDocument.recordTarget.patientRole.patient.birthTime**MAY** be precise to the minute (CONF:4537-32418).
:
4537-32948errorClinicalDocument.codeThis code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948).
:
81-7278errorClinicalDocument.recordTarget.patientRole.patient.name**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:
81-7296errorClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.informant:informant1.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.authenticator:authenticator1.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-8052warningClinicalDocument.component.structuredBody.component:component10.sectionIf the Operative Note Fluids section is present, there SHALL be a statement providing details of the fluids administered or SHALL explicitly state there were no fluids administered (CONF:81-8052).
:
81-8054warningClinicalDocument.component.structuredBody.component:component11.sectionIf the surgical procedure section is present there SHALL be text indicating the procedure performed (CONF:81-8054).
:
81-8056warningClinicalDocument.component.structuredBody.component:component16.sectionIf the Surgical Drains section is present, there SHALL be a statement providing details of the drains placed or SHALL explicitly state there were no drains placed (CONF:81-8056).
:
81-8741warningClinicalDocument.component.structuredBody.component:component4.sectionThe Estimated Blood Loss section SHALL include a statement providing an estimate of the amount of blood lost during the procedure, even if the estimate is text, such as "minimal" or "none" (CONF:81-8741).
:
81-8742warningClinicalDocument.component.structuredBody.component:component6.sectionThe Procedure Specimens Taken section SHALL list all specimens removed or SHALL explicitly state that no specimens were taken (CONF:81-8742).
:
81-8769errorClinicalDocument.component.structuredBody.component:component9.sectionThe Procedure Implants section **SHALL** include a statement providing details of the implants placed, or assert no implants were placed (CONF:81-8769).
:
81-9371errorClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
81-10078errorClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHALL** be precise to the day (CONF:81-10078).
:
81-10079warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHOULD** be precise to the minute (CONF:81-10079).
:
81-10080warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**MAY** be precise to the second (CONF:81-10080).
:
81-10081warningClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10081).
:
81-10127errorClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.time**SHALL** be precise to the day (CONF:81-10127).
:
81-10128warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.time**SHOULD** be precise to the minute (CONF:81-10128).
:
81-10129warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.time**MAY** be precise to the second (CONF:81-10129).
:
81-10130warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.timeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ivl-ts-centererrorClinicalDocument.documentationOf.serviceEvent.effectiveTimeCenter cannot co-exist with low or high
: center.empty() or (low.empty() and high.empty())
pn-no-lserrorClinicalDocument.recordTarget.patientRole.patient.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalDocument 1..1USRealmHeaderXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, copyTime, recordTarget, author, dataEnterer, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, relatedDocument, authorization, componentOf, component, realmCode, typeId, templateId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, recordTarget, author, dataEnterer, informant, informant, informant, custodian, informationRecipient, legalAuthenticator, authenticator, authenticator, participant, inFulfillmentOf, documentationOf, authorization, componentOf
Base for all types and resources
... @classCode 0..1csBinding: ActClass (extensible)
Fixed Value: DOCCLIN
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... realmCode 1..1CS
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: US
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... typeId 1..1II
.... @root 1..1stFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1stExtension
Fixed Value: POCD_HD000040
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:us-realm 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.1
..... @extension 1..1stRequired Pattern: 2023-05-01
.... templateId:secondary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.7
..... @extension 1..1stRequired Pattern: 2015-08-01
... id C1..1II
... code C1..1CEThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Binding: FHIRDocumentTypeCodes (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: SurgicalOperationNoteDocumentTypeCode (required)
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1STThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
... effectiveTime C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
... confidentialityCode 1..1CEBinding: HL7 BasicConfidentialityKind (preferred)
... languageCode 1..1CSBinding: VSAC 2.16.840.1.113883.1.11.11526 (required)
... setId C0..1II
... versionNumber C0..1INT
... copyTime 0..1TS
... recordTarget 1..*RecordTarget
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RCT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... patientRole 1..1PatientRole
..... @classCode 0..1csBinding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
..... templateId 0..*II
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... patient 1..1Patient
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... id 0..1II
...... name C1..*USRealmPatientNamePTNUSFIELDEDBase for all types and resources
...... sdtcDesc 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime C1..1TS
...... sdtcDeceasedInd C0..1BLXML Namespace: urn:hl7-org:sdtc
sdtc:deceasedInd
XML: deceasedInd (urn:hl7-org:sdtc)
...... sdtcDeceasedTime 0..1TSXML Namespace: urn:hl7-org:sdtc
sdtc:deceasedTime
XML: deceasedTime (urn:hl7-org:sdtc)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value C0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
...... sdtcMultipleBirthInd 0..1BLXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthInd (urn:hl7-org:sdtc)
...... sdtcMultipleBirthOrderNumber 0..1INT_POSXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
...... maritalStatusCode 0..1CEBinding: Marital Status (required)
...... religiousAffiliationCode 0..1CEBinding: Religious Affiliation (required)
...... raceCode 1..1CEBinding: Race Category Excluding Nulls (required)
...... sdtcRaceCode C0..*CEXML Namespace: urn:hl7-org:sdtc
The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.
XML: raceCode (urn:hl7-org:sdtc)
Binding: Race Value Set (required)
...... ethnicGroupCode 1..1CEBinding: Ethnicity (required)
...... sdtcEthnicGroupCode 0..*CEXML Namespace: urn:hl7-org:sdtc
ethnicGroupCode
XML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Detailed Ethnicity (required)
...... guardian 0..*Guardian
....... @classCode 0..1csBinding: RoleClassAgent (required)
Fixed Value: GUARD
....... templateId 0..*II
....... id 0..*II
....... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
....... code 0..1CEBinding: Personal And Legal Relationship Role Type (required)
....... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
....... telecom 0..*TEL
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @value 0..1url
........ useablePeriod 0..*
......... useablePeriodIVL_TS
......... useablePeriodEIVL_TS
......... useablePeriodPIVL_TS
......... useablePeriodSXPR_TS
........ @use 0..1csBinding: Telecom Use (US Realm Header) (required)
....... guardianPerson 1..1Person
........ @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
........ @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
........ templateId 0..*II
........ name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
........ sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
....... guardianOrganization 0..1Organization
...... birthplace 0..1Birthplace
....... @classCode 0..1csBinding: RoleClassPassive (required)
Fixed Value: BIRTHPL
....... templateId 0..*II
....... place 1..1Place
........ @classCode 0..1csBinding: EntityClassPlace (required)
Fixed Value: PLC
........ @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
........ templateId 0..*II
........ name 0..1EN
........ addr C1..1AD
......... nullFlavor C0..1csPrimitive Type code
Binding: NullFlavor (required)
......... @isNotOrdered 0..1bl
......... @use 0..*cs
......... delimiter 0..*ADXP
.......... @partType 0..1csFixed Value: DEL
......... country 0..1ADXP
.......... @partType 0..1csFixed Value: CNT
......... state 0..*ADXP
.......... @partType 0..1csFixed Value: STA
......... county 0..*ADXP
.......... @partType 0..1csFixed Value: CPA
......... city 0..*ADXP
.......... @partType 0..1csFixed Value: CTY
......... postalCode 0..*ADXP
.......... @partType 0..1csFixed Value: ZIP
......... streetAddressLine 0..*ADXP
.......... @partType 0..1csFixed Value: SAL
......... houseNumber 0..*ADXP
.......... @partType 0..1csFixed Value: BNR
......... houseNumberNumeric 0..*ADXP
.......... @partType 0..1csFixed Value: BNN
......... direction 0..*ADXP
.......... @partType 0..1csFixed Value: DIR
......... streetName 0..*ADXP
.......... @partType 0..1csFixed Value: STR
......... streetNameBase 0..*ADXP
.......... @partType 0..1csFixed Value: STB
......... streetNameType 0..*ADXP
.......... @partType 0..1csFixed Value: STTYP
......... additionalLocator 0..*ADXP
.......... @partType 0..1csFixed Value: ADL
......... unitID 0..*ADXP
.......... @partType 0..1csFixed Value: UNID
......... unitType 0..*ADXP
.......... @partType 0..1csFixed Value: UNIT
......... careOf 0..*ADXP
.......... @partType 0..1csFixed Value: CAR
......... censusTract 0..*ADXP
.......... @partType 0..1csFixed Value: CEN
......... deliveryAddressLine 0..*ADXP
.......... @partType 0..1csFixed Value: DAL
......... deliveryInstallationType 0..*ADXP
.......... @partType 0..1csFixed Value: DINST
......... deliveryInstallationArea 0..*ADXP
.......... @partType 0..1csFixed Value: DINSTA
......... deliveryInstallationQualifier 0..*ADXP
.......... @partType 0..1csFixed Value: DINSTQ
......... deliveryMode 0..*ADXP
.......... @partType 0..1csFixed Value: DMOD
......... deliveryModeIdentifier 0..*ADXP
.......... @partType 0..1csFixed Value: DMODID
......... buildingNumberSuffix 0..*ADXP
.......... @partType 0..1csFixed Value: BNS
......... postBox 0..*ADXP
.......... @partType 0..1csFixed Value: POB
......... precinct 0..*ADXP
.......... @partType 0..1csFixed Value: PRE
......... other 0..1st
......... useablePeriod 0..*
.......... useablePeriodIVL_TS
.......... useablePeriodEIVL_TS
.......... useablePeriodPIVL_TS
.......... useablePeriodSXPR_TS
...... languageCommunication 0..*LanguageCommunication
....... templateId 0..*II
....... languageCode 1..1CSBinding: VSAC 2.16.840.1.113883.1.11.11526 (required)
....... modeCode 0..1CEBinding: LanguageAbilityMode (required)
....... proficiencyLevelCode 0..1CEBinding: LanguageAbilityProficiency (required)
....... preferenceInd 0..1BL
..... providerOrganization 0..1Organization
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 1..*II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
...... name 1..*ON
...... telecom 1..*TEL
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value 0..1url
....... useablePeriod 0..*
........ useablePeriodIVL_TS
........ useablePeriodEIVL_TS
........ useablePeriodPIVL_TS
........ useablePeriodSXPR_TS
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
...... asOrganizationPartOf 0..1OrganizationPartOf
... author 1..*Author
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: AUT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CE
.... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
.... assignedAuthor C1..1AssignedAuthor
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... Slices for id 1..*IISlice: Unordered, Open by value:root
...... id:id1 0..1IIid
....... @nullFlavor 0..1csBinding: NullFlavor (required)
Fixed Value: UNK
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @code 1..1csBinding: Healthcare Provider Taxonomy (preferred)
...... @codeSystem 0..1oid, uuid, ruid
...... @codeSystemName 0..1st
...... @codeSystemVersion 0..1st
...... @displayName 0..1st
...... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1ED
...... translation 0..*CD
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... assignedPerson 0..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... assignedAuthoringDevice 0..1AuthoringDevice
...... @classCode 0..1csBinding: EntityClassDevice (required)
Fixed Value: DEV
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code 0..1CEBinding: EntityCode (extensible)
...... manufacturerModelName 1..1SCBinding: Manufacturer Model Name Example (example)
...... softwareName 1..1SCBinding: Software Name Example (example)
...... asMaintainedEntity 0..*MaintainedEntity
..... representedOrganization 0..1Organization
... dataEnterer 0..1DataEnterer
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: ENT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... time 1..1TS
.... assignedEntity 1..1AssignedEntity
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
...... @extension 0..1st
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... assignedPerson 1..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... representedOrganization 0..1Organization
... Slices for informant 0..*InformantSlice: Unordered, Open by value:relatedEntity
.... informant:informant1 0..*Informantinformant
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: INF
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... assignedEntity 1..1AssignedEntity
...... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
...... templateId 0..*II
...... id C1..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... assignedPerson 1..1Person
....... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
....... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... representedOrganization 0..1Organization
..... relatedEntity 0..1RelatedEntity
.... informant:informant2 0..*Informantinformant
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: INF
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... assignedEntity 0..1AssignedEntity
..... relatedEntity 1..1RelatedEntity
... custodian 1..1Custodian
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: ENT
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... assignedCustodian 1..1AssignedCustodian
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... representedCustodianOrganization 1..1CustodianOrganization
...... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... id 1..*II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
...... name 1..1ON
...... telecom 1..1TEL
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value 0..1url
....... useablePeriod 0..*
........ useablePeriodIVL_TS
........ useablePeriodEIVL_TS
........ useablePeriodPIVL_TS
........ useablePeriodSXPR_TS
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... addr C1..1USRealmAddressADUSFIELDEDBase for all types and resources
... informationRecipient 0..*InformationRecipient
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... intendedRecipient 1..1IntendedRecipient
..... @classCode 1..1cs
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... addr 0..*AD
..... telecom 0..*TEL
..... informationRecipient 0..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... receivedOrganization 0..1Organization
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 0..*II
...... name 1..1ON
...... telecom 0..*TEL
...... addr 0..*AD
...... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
...... asOrganizationPartOf 0..1OrganizationPartOf
... legalAuthenticator 0..1LegalAuthenticator
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
.... signatureCode 1..1CS
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @code 1..1csRequired Pattern: S
..... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
..... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
XML: signatureText (urn:hl7-org:sdtc)
.... assignedEntity 1..1AssignedEntity
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
...... @extension 0..1st
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... assignedPerson 1..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... representedOrganization 0..1Organization
... Slices for authenticator 0..*AuthenticatorSlice: Unordered, Open by value:ClinicalDocument.signatureCode, value:ClinicalDocument.assignedEntity, value:ClinicalDocument.time
.... authenticator:authenticator1 0..*Authenticatorauthenticator
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: AUTHEN
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
..... signatureCode 1..1CS
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @code 1..1csRequired Pattern: S
...... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
..... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
XML: signatureText (urn:hl7-org:sdtc)
..... assignedEntity 1..1AssignedEntity
...... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
...... templateId 0..*II
...... id 1..*II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: v3 Code System RoleCode (extensible)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @code 0..1csBinding: Healthcare Provider Taxonomy (preferred)
....... @codeSystem 0..1oid, uuid, ruid
....... @codeSystemName 0..1st
....... @codeSystemVersion 0..1st
....... @displayName 0..1st
....... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
....... originalText 0..1ED
....... translation 0..*CD
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 1..*TEL
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value 0..1url
....... useablePeriod 0..*
........ useablePeriodIVL_TS
........ useablePeriodEIVL_TS
........ useablePeriodPIVL_TS
........ useablePeriodSXPR_TS
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... assignedPerson 1..1Person
....... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
....... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... representedOrganization 0..1Organization
... participant C0..*Participant1
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CE
.... time 0..1IVL_TS
.... associatedEntity 1..1AssociatedEntity
... inFulfillmentOf 0..*InFulfillmentOf
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: FLFS
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... order 1..1Order
..... @classCode 1..1csBinding: ActClass (required)
..... @moodCode 0..1csBinding: ActMoodIntent (required)
Fixed Value: RQO
..... templateId 0..*II
..... id 1..*II
..... code 0..1CEBinding: v3 Code System ActCode (extensible)
..... priorityCode 0..1CEBinding: ActPriority (extensible)
... documentationOf 1..*DocumentationOfA serviceEvent represents the main act, such as a colonoscopy or an appendectomy, being documented. A serviceEvent can further specialize the act inherent in the ClinicalDocument/code, such as where the ClinicalDocument/code is simply "Surgical Operation Note" and the procedure is "Appendectomy." serviceEvent is required in the Operative Note and it must be equivalent to or further specialize the value inherent in the ClinicalDocument/code; it shall not conflict with the value inherent in the ClinicalDocument/code, as such a conflict would create ambiguity. serviceEvent/effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place. If the date and the duration of the procedure is known, serviceEvent/effectiveTime/low is used with a width element that describes the duration; no high element is used. However, if only the date is known, the date is placed in both the low and high elements.
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: DOC
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... serviceEvent C1..1ServiceEvent1198-8487: The value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
..... @classCode 1..1csBinding: ActClass (required)
..... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id 0..*II
..... code 0..1CE
..... effectiveTime C1..1USRealmDateandTimeDTUSFIELDEDBase for all types and resources
1198-8488: The serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
1198-10058: If a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
1198-10060: When only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
...... @operator 0..1csBinding: SetOperator (required)
...... low 1..1IVXB_TS
...... center 0..1TS
...... width 0..1PQ
...... high 0..1IVXB_TS
..... Slices for performer 1..*Performer1This performer represents any assistants.
Slice: Unordered, Open by value:assignedEntity, value:typeCode, value:functionCode
...... performer:All Slices Content/Rules for all slices
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... functionCode 0..1CE
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @code 0..1csBinding: Care Team Member Function (preferred)
........ @codeSystem 0..1oid, uuid, ruid
........ @codeSystemName 0..1st
........ @codeSystemVersion 0..1st
........ @displayName 0..1st
........ @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
........ @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
........ originalText 0..1ED
........ translation 0..*CD
....... time 0..1IVL_TS
....... assignedEntity 1..1AssignedEntity
........ @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
........ templateId 0..*II
........ id 1..*II
......... @nullFlavor 0..1csBinding: NullFlavor (required)
......... @assigningAuthorityName 0..1st
......... @displayable 0..1bl
......... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
......... @extension 0..1st
........ sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
........ code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
........ addr 0..*AD
........ telecom 0..*TEL
........ assignedPerson 0..1Person
........ representedOrganization 0..1Organization
...... performer:performer1 1..*Performer1This performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: PPRF
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @code 0..1csBinding: Care Team Member Function (preferred)
........ @codeSystem 0..1oid, uuid, ruid
........ @codeSystemName 0..1st
........ @codeSystemVersion 0..1st
........ @displayName 0..1st
........ @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
........ @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
........ originalText 0..1ED
........ translation 0..*CD
....... time 0..1IVL_TS
....... assignedEntity 1..1AssignedEntity
........ @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
........ templateId 0..*II
........ id 1..*II
......... @nullFlavor 0..1csBinding: NullFlavor (required)
......... @assigningAuthorityName 0..1st
......... @displayable 0..1bl
......... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
......... @extension 0..1st
........ sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
........ addr 0..*AD
........ telecom 0..*TEL
........ assignedPerson 0..1Person
........ representedOrganization 0..1Organization
...... performer:performer2 0..*Performer1
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: SPRF
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @code 0..1csBinding: Care Team Member Function (preferred)
........ @codeSystem 0..1oid, uuid, ruid
........ @codeSystemName 0..1st
........ @codeSystemVersion 0..1st
........ @displayName 0..1st
........ @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
........ @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
........ originalText 0..1ED
........ translation 0..*CD
....... time 0..1IVL_TS
....... assignedEntity 1..1AssignedEntity
........ @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
........ templateId 0..*II
........ id 1..*II
......... @nullFlavor 0..1csBinding: NullFlavor (required)
......... @assigningAuthorityName 0..1st
......... @displayable 0..1bl
......... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
......... @extension 0..1st
........ sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
........ addr 0..*AD
........ telecom 0..*TEL
........ assignedPerson 0..1Person
........ representedOrganization 0..1Organization
... relatedDocument 0..*RelatedDocument
... authorization 0..1AuthorizationAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: AUTH
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... consent 1..1Consent
..... @classCode 1..1csBinding: ActClass (required)
Fixed Value: CONS
..... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id 0..*II
..... code 0..1CEThe type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.
Binding: v3 Code System ActCode (extensible)
..... statusCode 1..1CSBinding: ActStatus (required)
...... @code 1..1csFixed Value: completed
... componentOf 0..1ComponentOf
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
Fixed Value: COMP
.... encompassingEncounter 1..1EncompassingEncounter
..... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
..... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id 1..*II
..... code 0..1CEBinding: ActEncounterCode (extensible)
..... effectiveTime 1..1IVL_TS
..... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
..... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
..... responsibleParty 0..1InfrastructureRoot
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
...... assignedEntity 1..1AssignedEntity
..... encounterParticipant 0..*EncounterParticipant
..... location 0..1InfrastructureRoot
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
...... healthCareFacility 1..1HealthCareFacility
... component 1..1Component
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
Fixed Value: COMP
.... @contextConductionInd 0..1blFixed Value: true
.... nonXMLBody 0..1NonXMLBody
.... structuredBody 1..1StructuredBody
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @classCode 0..1csBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCBODY
..... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
..... confidentialityCode 0..1CE
..... languageCode 0..1CSBinding: HumanLanguage (required)
..... Slices for component 8..*InfrastructureRootSlice: Unordered, Open by value:ClinicalDocument.section
...... component:All Slices Content/Rules for all slices
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1Section
...... component:component1 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1AnesthesiaSectionBase for all types and resources
...... component:component2 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ComplicationsSectionBase for all types and resources
...... component:component3 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PreoperativeDiagnosisSectionBase for all types and resources
...... component:component4 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1ProcedureEstimatedBloodLossSectionBase for all types and resources
...... component:component5 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureFindingsSectionBase for all types and resources
...... component:component6 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1ProcedureSpecimensTakenSectionBase for all types and resources
...... component:component7 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureDescriptionSectionBase for all types and resources
...... component:component8 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PostoperativeDiagnosisSectionBase for all types and resources
...... component:component9 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1ProcedureImplantsSectionBase for all types and resources
...... component:component10 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1OperativeNoteFluidsSectionBase for all types and resources
...... component:component11 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1OperativeNoteSurgicalProcedureSectionBase for all types and resources
...... component:component12 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PlanofTreatmentSectionBase for all types and resources
...... component:component13 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PlannedProcedureSectionBase for all types and resources
...... component:component14 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureDispositionSectionBase for all types and resources
...... component:component15 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureIndicationsSectionBase for all types and resources
...... component:component16 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1SurgicalDrainsSectionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClinicalDocument.classCodeextensibleFixed Value: DOCCLIN
ClinicalDocument.moodCoderequiredFixed Value: EVN
ClinicalDocument.realmCode.nullFlavorrequiredNullFlavor
ClinicalDocument.templateId:us-realm.nullFlavorrequiredNullFlavor
ClinicalDocument.templateId:secondary.nullFlavorrequiredNullFlavor
ClinicalDocument.codeextensibleFHIRDocumentTypeCodes
ClinicalDocument.code.nullFlavorrequiredNullFlavor
ClinicalDocument.code.coderequiredSurgicalOperationNoteDocumentTypeCode
ClinicalDocument.confidentialityCodepreferredHL7 BasicConfidentialityKind
ClinicalDocument.languageCoderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526
ClinicalDocument.recordTarget.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.typeCoderequiredFixed Value: RCT
ClinicalDocument.recordTarget.contextControlCoderequiredFixed Value: OP
ClinicalDocument.recordTarget.patientRole.classCoderequiredFixed Value: PAT
ClinicalDocument.recordTarget.patientRole.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.patient.classCoderequiredFixed Value: PSN
ClinicalDocument.recordTarget.patientRole.patient.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)
ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCoderequiredMarital Status
ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCoderequiredReligious Affiliation
ClinicalDocument.recordTarget.patientRole.patient.raceCoderequiredRace Category Excluding Nulls
ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCoderequiredRace Value Set
ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCoderequiredEthnicity
ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCoderequiredDetailed Ethnicity
ClinicalDocument.recordTarget.patientRole.patient.guardian.classCoderequiredFixed Value: GUARD
ClinicalDocument.recordTarget.patientRole.patient.guardian.coderequiredPersonal And Legal Relationship Role Type
ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCoderequiredFixed Value: BIRTHPL
ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCoderequiredFixed Value: PLC
ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCoderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526
ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCoderequiredLanguageAbilityMode
ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCoderequiredLanguageAbilityProficiency
ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.providerOrganization.classCoderequiredFixed Value: ORG
ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS
ClinicalDocument.author.nullFlavorrequiredNullFlavor
ClinicalDocument.author.typeCoderequiredFixed Value: AUT
ClinicalDocument.author.contextControlCoderequiredFixed Value: OP
ClinicalDocument.author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.author.assignedAuthor.id:id1.nullFlavorrequiredFixed Value: UNK
ClinicalDocument.author.assignedAuthor.codeextensibleRoleCode
ClinicalDocument.author.assignedAuthor.code.nullFlavorrequiredNullFlavor
ClinicalDocument.author.assignedAuthor.code.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.author.assignedAuthor.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.author.assignedAuthor.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.author.assignedAuthor.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCoderequiredFixed Value: DEV
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.codeextensibleEntityCode
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelNameexampleManufacturerModelNameExample
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareNameexampleSoftwareNameExample
ClinicalDocument.dataEnterer.nullFlavorrequiredNullFlavor
ClinicalDocument.dataEnterer.typeCoderequiredFixed Value: ENT
ClinicalDocument.dataEnterer.contextControlCoderequiredFixed Value: OP
ClinicalDocument.dataEnterer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.dataEnterer.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.dataEnterer.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informant:informant1.nullFlavorrequiredNullFlavor
ClinicalDocument.informant:informant1.typeCoderequiredFixed Value: INF
ClinicalDocument.informant:informant1.contextControlCoderequiredFixed Value: OP
ClinicalDocument.informant:informant1.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.informant:informant1.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informant:informant2.nullFlavorrequiredNullFlavor
ClinicalDocument.informant:informant2.typeCoderequiredFixed Value: INF
ClinicalDocument.informant:informant2.contextControlCoderequiredFixed Value: OP
ClinicalDocument.custodian.nullFlavorrequiredNullFlavor
ClinicalDocument.custodian.typeCoderequiredFixed Value: ENT
ClinicalDocument.custodian.assignedCustodian.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCoderequiredFixed Value: ORG
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavorrequiredNullFlavor
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.informationRecipient.nullFlavorrequiredNullFlavor
ClinicalDocument.informationRecipient.typeCoderequiredParticipationType
ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCoderequiredFixed Value: PSN
ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavorrequiredNullFlavor
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCoderequiredFixed Value: ORG
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS
ClinicalDocument.legalAuthenticator.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.typeCoderequiredFixed Value: LA
ClinicalDocument.legalAuthenticator.contextControlCoderequiredFixed Value: OP
ClinicalDocument.legalAuthenticator.signatureCode.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.authenticator:authenticator1.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.typeCoderequiredFixed Value: AUTHEN
ClinicalDocument.authenticator:authenticator1.signatureCode.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.authenticator:authenticator1.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.codeextensibleRoleCode
ClinicalDocument.authenticator:authenticator1.assignedEntity.code.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.participant.nullFlavorrequiredNullFlavor
ClinicalDocument.participant.typeCoderequiredParticipationType
ClinicalDocument.participant.contextControlCoderequiredFixed Value: OP
ClinicalDocument.inFulfillmentOf.nullFlavorrequiredNullFlavor
ClinicalDocument.inFulfillmentOf.typeCoderequiredFixed Value: FLFS
ClinicalDocument.inFulfillmentOf.order.classCoderequiredActClass
ClinicalDocument.inFulfillmentOf.order.moodCoderequiredFixed Value: RQO
ClinicalDocument.inFulfillmentOf.order.codeextensibleActCode
ClinicalDocument.inFulfillmentOf.order.priorityCodeextensibleActPriority
ClinicalDocument.documentationOf.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.typeCoderequiredFixed Value: DOC
ClinicalDocument.documentationOf.serviceEvent.classCoderequiredActClass
ClinicalDocument.documentationOf.serviceEvent.moodCoderequiredFixed Value: EVN
ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operatorrequiredSetOperator
ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer.typeCoderequiredx_ServiceEventPerformer
ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCoderequiredFixed Value: PPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.codepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.typeCoderequiredFixed Value: SPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.codepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.authorization.nullFlavorrequiredNullFlavor
ClinicalDocument.authorization.typeCoderequiredFixed Value: AUTH
ClinicalDocument.authorization.consent.classCoderequiredFixed Value: CONS
ClinicalDocument.authorization.consent.moodCoderequiredFixed Value: EVN
ClinicalDocument.authorization.consent.codeextensibleActCode
ClinicalDocument.authorization.consent.statusCoderequiredActStatus
ClinicalDocument.componentOf.nullFlavorrequiredNullFlavor
ClinicalDocument.componentOf.typeCoderequiredFixed Value: COMP
ClinicalDocument.componentOf.encompassingEncounter.classCoderequiredFixed Value: ENC
ClinicalDocument.componentOf.encompassingEncounter.moodCoderequiredFixed Value: EVN
ClinicalDocument.componentOf.encompassingEncounter.codeextensibleActEncounterCode
ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavorrequiredNullFlavor
ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavorrequiredNullFlavor
ClinicalDocument.componentOf.encompassingEncounter.location.typeCoderequiredFixed Value: LOC
ClinicalDocument.component.nullFlavorrequiredNullFlavor
ClinicalDocument.component.typeCoderequiredFixed Value: COMP
ClinicalDocument.component.structuredBody.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.classCoderequiredFixed Value: DOCBODY
ClinicalDocument.component.structuredBody.moodCoderequiredFixed Value: EVN
ClinicalDocument.component.structuredBody.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ClinicalDocument.component.structuredBody.component.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component1.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component2.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component3.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component4.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component5.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component6.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component7.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component8.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component9.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component10.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component11.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component12.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component13.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component14.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component15.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component16.nullFlavorrequiredNullFlavor

Constraints

IdGradePath(s)DetailsRequirements
1198-8487errorClinicalDocument.documentationOf.serviceEventThe value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
:
1198-8488errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeThe serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
:
1198-10058errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
:
1198-10060errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeWhen only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
:
4537-5299errorClinicalDocument.recordTarget.patientRole.patient.birthTime**SHALL** be precise to year (CONF:4537-5299).
:
4537-5300warningClinicalDocument.recordTarget.patientRole.patient.birthTime**SHOULD** be precise to day (CONF:4537-5300).
:
4537-5402warningClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addrIf country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:4537-5402).
:
4537-5403warningClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addrIf country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403).
:
4537-6380errorClinicalDocument.setIdIf setId is present versionNumber **SHALL** be present (CONF:4537-6380).
:
4537-6387errorClinicalDocument.versionNumberIf versionNumber is present setId **SHALL** be present (CONF:4537-6387).
:
4537-9946warningClinicalDocument.informant:informant1.assignedEntity.idIf assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946).
:
4537-9991warningClinicalDocument.idThis id **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
:
4537-9992errorClinicalDocument.codeThis code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
:
4537-10006errorClinicalDocument.participant**SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006).
:
4537-10007warningClinicalDocument.participantWhen participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007).
:
4537-16790errorClinicalDocument.author.assignedAuthorThere **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790).
:
4537-31347errorClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCodeIf sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347).
:
4537-32418warningClinicalDocument.recordTarget.patientRole.patient.birthTime**MAY** be precise to the minute (CONF:4537-32418).
:
4537-32948errorClinicalDocument.codeThis code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948).
:
4537-32991errorClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.value**SHALL** be precise to to the year (CONF:4537-32991).
:
4537-32992warningClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.value**SHOULD** be precise to the day (CONF:4537-32992).
:
4537-32993errorClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedIndIf sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993).
:
81-7278errorClinicalDocument.recordTarget.patientRole.patient.name**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:
81-7296errorClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:informant1.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator:authenticator1.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-8052warningClinicalDocument.component.structuredBody.component:component10.sectionIf the Operative Note Fluids section is present, there SHALL be a statement providing details of the fluids administered or SHALL explicitly state there were no fluids administered (CONF:81-8052).
:
81-8054warningClinicalDocument.component.structuredBody.component:component11.sectionIf the surgical procedure section is present there SHALL be text indicating the procedure performed (CONF:81-8054).
:
81-8056warningClinicalDocument.component.structuredBody.component:component16.sectionIf the Surgical Drains section is present, there SHALL be a statement providing details of the drains placed or SHALL explicitly state there were no drains placed (CONF:81-8056).
:
81-8741warningClinicalDocument.component.structuredBody.component:component4.sectionThe Estimated Blood Loss section SHALL include a statement providing an estimate of the amount of blood lost during the procedure, even if the estimate is text, such as "minimal" or "none" (CONF:81-8741).
:
81-8742warningClinicalDocument.component.structuredBody.component:component6.sectionThe Procedure Specimens Taken section SHALL list all specimens removed or SHALL explicitly state that no specimens were taken (CONF:81-8742).
:
81-8769errorClinicalDocument.component.structuredBody.component:component9.sectionThe Procedure Implants section **SHALL** include a statement providing details of the implants placed, or assert no implants were placed (CONF:81-8769).
:
81-9371errorClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
81-10078errorClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHALL** be precise to the day (CONF:81-10078).
:
81-10079warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHOULD** be precise to the minute (CONF:81-10079).
:
81-10080warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**MAY** be precise to the second (CONF:81-10080).
:
81-10081warningClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10081).
:
81-10127errorClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.time**SHALL** be precise to the day (CONF:81-10127).
:
81-10128warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.time**SHOULD** be precise to the minute (CONF:81-10128).
:
81-10129warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.time**MAY** be precise to the second (CONF:81-10129).
:
81-10130warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.timeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).
:
cs-patternerrorClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavorcs attributes must not contain any whitespace
: matches('^[^\\s]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ivl-ts-centererrorClinicalDocument.documentationOf.serviceEvent.effectiveTimeCenter cannot co-exist with low or high
: center.empty() or (low.empty() and high.empty())
pn-no-lserrorClinicalDocument.recordTarget.patientRole.patient.name, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

This structure is derived from USRealmHeader

Summary

Mandatory: 16 elements (3 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element ClinicalDocument.documentationOf.serviceEvent.performer is sliced based on the values of value:assignedEntity, value:typeCode, value:functionCode
  • The element ClinicalDocument.component.structuredBody.component is sliced based on the value of value:ClinicalDocument.section

Differential View

This structure is derived from USRealmHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalDocument 1..1USRealmHeaderXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, copyTime, recordTarget, author, dataEnterer, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, relatedDocument, authorization, componentOf, component, realmCode, typeId, templateId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, recordTarget, author, dataEnterer, informant, informant, informant, custodian, informationRecipient, legalAuthenticator, authenticator, authenticator, participant, inFulfillmentOf, documentationOf, authorization, componentOf
Base for all types and resources
... templateId 2..*II
... templateId:secondary 1..1II
.... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.7
.... extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CEThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
.... code 1..1csBinding: SurgicalOperationNoteDocumentTypeCode (required)
.... serviceEvent C1..1ServiceEvent1198-8487: The value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
..... effectiveTime C1..1USRealmDateandTimeDTUSFIELDEDBase for all types and resources
1198-8488: The serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
1198-10058: If a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
1198-10060: When only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
..... Slices for performer 1..*Performer1This performer represents any assistants.
Slice: Unordered, Open by value:assignedEntity, value:typeCode, value:functionCode
...... performer:performer1 1..*Performer1This performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
....... typeCode 1..1csFixed Value: PPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
...... performer:performer2 0..*Performer1
....... typeCode 1..1csFixed Value: SPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
... authorization 0..1AuthorizationAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
.... typeCode 1..1cs
.... consent 1..1Consent
..... classCode 1..1cs
..... moodCode 1..1cs
..... statusCode 1..1CS
... component 1..1Component
.... structuredBody 1..1StructuredBody
..... Slices for component 8..*InfrastructureRootSlice: Unordered, Open by value:ClinicalDocument.section
...... component:component1 1..1InfrastructureRoot
....... section 1..1AnesthesiaSectionBase for all types and resources
...... component:component2 1..1InfrastructureRoot
....... section 1..1ComplicationsSectionBase for all types and resources
...... component:component3 1..1InfrastructureRoot
....... section 1..1PreoperativeDiagnosisSectionBase for all types and resources
...... component:component4 1..1InfrastructureRoot
....... section 1..1ProcedureEstimatedBloodLossSectionBase for all types and resources
...... component:component5 1..1InfrastructureRoot
....... section 1..1ProcedureFindingsSectionBase for all types and resources
...... component:component6 1..1InfrastructureRoot
....... section 1..1ProcedureSpecimensTakenSectionBase for all types and resources
...... component:component7 1..1InfrastructureRoot
....... section 1..1ProcedureDescriptionSectionBase for all types and resources
...... component:component8 1..1InfrastructureRoot
....... section 1..1PostoperativeDiagnosisSectionBase for all types and resources
...... component:component9 0..1InfrastructureRoot
....... section 1..1ProcedureImplantsSectionBase for all types and resources
...... component:component10 0..1InfrastructureRoot
....... section 1..1OperativeNoteFluidsSectionBase for all types and resources
...... component:component11 0..1InfrastructureRoot
....... section 1..1OperativeNoteSurgicalProcedureSectionBase for all types and resources
...... component:component12 0..1InfrastructureRoot
....... section 1..1PlanofTreatmentSectionBase for all types and resources
...... component:component13 0..1InfrastructureRoot
....... section 1..1PlannedProcedureSectionBase for all types and resources
...... component:component14 0..1InfrastructureRoot
....... section 1..1ProcedureDispositionSectionBase for all types and resources
...... component:component15 0..1InfrastructureRoot
....... section 1..1ProcedureIndicationsSectionBase for all types and resources
...... component:component16 0..1InfrastructureRoot
....... section 1..1SurgicalDrainsSectionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ClinicalDocument.code.coderequiredSurgicalOperationNoteDocumentTypeCode
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)

Constraints

IdGradePath(s)DetailsRequirements
1198-8487errorClinicalDocument.documentationOf.serviceEventThe value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
:
1198-8488errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeThe serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
:
1198-10058errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
:
1198-10060errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeWhen only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalDocument 1..1USRealmHeaderXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, copyTime, recordTarget, author, dataEnterer, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, relatedDocument, authorization, componentOf, component, realmCode, typeId, templateId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, recordTarget, author, dataEnterer, informant, informant, informant, custodian, informationRecipient, legalAuthenticator, authenticator, authenticator, participant, inFulfillmentOf, documentationOf, authorization, componentOf
Base for all types and resources
... realmCode 1..1CS
.... @code 1..1csRequired Pattern: US
... typeId 1..1II
.... @root 1..1stFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1stExtension
Fixed Value: POCD_HD000040
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:us-realm 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.1
..... @extension 1..1stRequired Pattern: 2023-05-01
.... templateId:secondary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.7
..... @extension 1..1stRequired Pattern: 2015-08-01
... code C1..1CEThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Binding: FHIRDocumentTypeCodes (extensible)
.... @code 1..1csBinding: SurgicalOperationNoteDocumentTypeCode (required)
... title 1..1STThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
... effectiveTime C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
... confidentialityCode 1..1CEBinding: HL7 BasicConfidentialityKind (preferred)
... languageCode 1..1CSBinding: VSAC 2.16.840.1.113883.1.11.11526 (required)
... recordTarget 1..*RecordTarget
.... patientRole 1..1PatientRole
..... id 1..*II
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... patient 1..1Patient
...... name C1..*USRealmPatientNamePTNUSFIELDEDBase for all types and resources
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime C1..1TS
...... raceCode 1..1CEBinding: Race Category Excluding Nulls (required)
...... ethnicGroupCode 1..1CEBinding: Ethnicity (required)
... author 1..*Author
.... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
.... assignedAuthor C1..1AssignedAuthor
..... Slices for id 1..*IISlice: Unordered, Open by value:root
...... id:id1 0..1IIid
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
... Slices for informant 0..*InformantSlice: Unordered, Open by value:relatedEntity
.... informant:informant1 0..*Informantinformant
..... assignedEntity 1..1AssignedEntity
...... id C1..*II
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... assignedPerson 1..1Person
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
.... informant:informant2 0..*Informantinformant
..... relatedEntity 1..1RelatedEntity
... custodian 1..1Custodian
.... assignedCustodian 1..1AssignedCustodian
..... representedCustodianOrganization 1..1CustodianOrganization
...... id 1..*II
...... name 1..1ON
...... telecom 1..1TEL
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... addr C1..1USRealmAddressADUSFIELDEDBase for all types and resources
... Slices for authenticator 0..*AuthenticatorSlice: Unordered, Open by value:ClinicalDocument.signatureCode, value:ClinicalDocument.assignedEntity, value:ClinicalDocument.time
.... authenticator:authenticator1 0..*Authenticatorauthenticator
..... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
..... signatureCode 1..1CS
...... @code 1..1csRequired Pattern: S
..... assignedEntity 1..1AssignedEntity
...... id 1..*II
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 1..*TEL
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... assignedPerson 1..1Person
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
... documentationOf 1..*DocumentationOfA serviceEvent represents the main act, such as a colonoscopy or an appendectomy, being documented. A serviceEvent can further specialize the act inherent in the ClinicalDocument/code, such as where the ClinicalDocument/code is simply "Surgical Operation Note" and the procedure is "Appendectomy." serviceEvent is required in the Operative Note and it must be equivalent to or further specialize the value inherent in the ClinicalDocument/code; it shall not conflict with the value inherent in the ClinicalDocument/code, as such a conflict would create ambiguity. serviceEvent/effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place. If the date and the duration of the procedure is known, serviceEvent/effectiveTime/low is used with a width element that describes the duration; no high element is used. However, if only the date is known, the date is placed in both the low and high elements.
.... serviceEvent C1..1ServiceEvent1198-8487: The value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
..... @classCode 1..1csBinding: ActClass (required)
..... effectiveTime C1..1USRealmDateandTimeDTUSFIELDEDBase for all types and resources
1198-8488: The serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
1198-10058: If a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
1198-10060: When only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
...... low 1..1IVXB_TS
..... Slices for performer 1..*Performer1This performer represents any assistants.
Slice: Unordered, Open by value:assignedEntity, value:typeCode, value:functionCode
...... performer:All Slices Content/Rules for all slices
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
....... assignedEntity 1..1AssignedEntity
........ id 1..*II
...... performer:performer1 1..*Performer1This performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: PPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ id 1..*II
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
...... performer:performer2 0..*Performer1
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: SPRF
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
....... assignedEntity 1..1AssignedEntity
........ id 1..*II
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
... authorization 0..1AuthorizationAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: AUTH
.... consent 1..1Consent
..... @classCode 1..1csBinding: ActClass (required)
Fixed Value: CONS
..... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
..... statusCode 1..1CSBinding: ActStatus (required)
...... @code 1..1csFixed Value: completed
... component 1..1Component
.... structuredBody 1..1StructuredBody
..... Slices for component 8..*InfrastructureRootSlice: Unordered, Open by value:ClinicalDocument.section
...... component:All Slices Content/Rules for all slices
....... section 1..1Section
...... component:component1 1..1InfrastructureRoot
....... section 1..1AnesthesiaSectionBase for all types and resources
...... component:component2 1..1InfrastructureRoot
....... section 1..1ComplicationsSectionBase for all types and resources
...... component:component3 1..1InfrastructureRoot
....... section 1..1PreoperativeDiagnosisSectionBase for all types and resources
...... component:component4 1..1InfrastructureRoot
....... section C1..1ProcedureEstimatedBloodLossSectionBase for all types and resources
...... component:component5 1..1InfrastructureRoot
....... section 1..1ProcedureFindingsSectionBase for all types and resources
...... component:component6 1..1InfrastructureRoot
....... section C1..1ProcedureSpecimensTakenSectionBase for all types and resources
...... component:component7 1..1InfrastructureRoot
....... section 1..1ProcedureDescriptionSectionBase for all types and resources
...... component:component8 1..1InfrastructureRoot
....... section 1..1PostoperativeDiagnosisSectionBase for all types and resources
...... component:component9 0..1InfrastructureRoot
....... section C1..1ProcedureImplantsSectionBase for all types and resources
...... component:component10 0..1InfrastructureRoot
....... section C1..1OperativeNoteFluidsSectionBase for all types and resources
...... component:component11 0..1InfrastructureRoot
....... section C1..1OperativeNoteSurgicalProcedureSectionBase for all types and resources
...... component:component12 0..1InfrastructureRoot
....... section 1..1PlanofTreatmentSectionBase for all types and resources
...... component:component13 0..1InfrastructureRoot
....... section 1..1PlannedProcedureSectionBase for all types and resources
...... component:component14 0..1InfrastructureRoot
....... section 1..1ProcedureDispositionSectionBase for all types and resources
...... component:component15 0..1InfrastructureRoot
....... section 1..1ProcedureIndicationsSectionBase for all types and resources
...... component:component16 0..1InfrastructureRoot
....... section C1..1SurgicalDrainsSectionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClinicalDocument.codeextensibleFHIRDocumentTypeCodes
ClinicalDocument.code.coderequiredSurgicalOperationNoteDocumentTypeCode
ClinicalDocument.confidentialityCodepreferredHL7 BasicConfidentialityKind
ClinicalDocument.languageCoderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526
ClinicalDocument.recordTarget.patientRole.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)
ClinicalDocument.recordTarget.patientRole.patient.raceCoderequiredRace Category Excluding Nulls
ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCoderequiredEthnicity
ClinicalDocument.author.assignedAuthor.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.documentationOf.serviceEvent.classCoderequiredActClass
ClinicalDocument.documentationOf.serviceEvent.performer.typeCoderequiredx_ServiceEventPerformer
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCoderequiredFixed Value: PPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.typeCoderequiredFixed Value: SPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.authorization.typeCoderequiredFixed Value: AUTH
ClinicalDocument.authorization.consent.classCoderequiredFixed Value: CONS
ClinicalDocument.authorization.consent.moodCoderequiredFixed Value: EVN
ClinicalDocument.authorization.consent.statusCoderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
1198-8487errorClinicalDocument.documentationOf.serviceEventThe value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
:
1198-8488errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeThe serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
:
1198-10058errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
:
1198-10060errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeWhen only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
:
4537-5299errorClinicalDocument.recordTarget.patientRole.patient.birthTime**SHALL** be precise to year (CONF:4537-5299).
:
4537-5300warningClinicalDocument.recordTarget.patientRole.patient.birthTime**SHOULD** be precise to day (CONF:4537-5300).
:
4537-9946warningClinicalDocument.informant:informant1.assignedEntity.idIf assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946).
:
4537-9991warningClinicalDocument.idThis id **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
:
4537-9992errorClinicalDocument.codeThis code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
:
4537-16790errorClinicalDocument.author.assignedAuthorThere **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790).
:
4537-32418warningClinicalDocument.recordTarget.patientRole.patient.birthTime**MAY** be precise to the minute (CONF:4537-32418).
:
4537-32948errorClinicalDocument.codeThis code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948).
:
81-7278errorClinicalDocument.recordTarget.patientRole.patient.name**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:
81-7296errorClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.informant:informant1.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.authenticator:authenticator1.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-8052warningClinicalDocument.component.structuredBody.component:component10.sectionIf the Operative Note Fluids section is present, there SHALL be a statement providing details of the fluids administered or SHALL explicitly state there were no fluids administered (CONF:81-8052).
:
81-8054warningClinicalDocument.component.structuredBody.component:component11.sectionIf the surgical procedure section is present there SHALL be text indicating the procedure performed (CONF:81-8054).
:
81-8056warningClinicalDocument.component.structuredBody.component:component16.sectionIf the Surgical Drains section is present, there SHALL be a statement providing details of the drains placed or SHALL explicitly state there were no drains placed (CONF:81-8056).
:
81-8741warningClinicalDocument.component.structuredBody.component:component4.sectionThe Estimated Blood Loss section SHALL include a statement providing an estimate of the amount of blood lost during the procedure, even if the estimate is text, such as "minimal" or "none" (CONF:81-8741).
:
81-8742warningClinicalDocument.component.structuredBody.component:component6.sectionThe Procedure Specimens Taken section SHALL list all specimens removed or SHALL explicitly state that no specimens were taken (CONF:81-8742).
:
81-8769errorClinicalDocument.component.structuredBody.component:component9.sectionThe Procedure Implants section **SHALL** include a statement providing details of the implants placed, or assert no implants were placed (CONF:81-8769).
:
81-9371errorClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
81-10078errorClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHALL** be precise to the day (CONF:81-10078).
:
81-10079warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHOULD** be precise to the minute (CONF:81-10079).
:
81-10080warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**MAY** be precise to the second (CONF:81-10080).
:
81-10081warningClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10081).
:
81-10127errorClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.time**SHALL** be precise to the day (CONF:81-10127).
:
81-10128warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.time**SHOULD** be precise to the minute (CONF:81-10128).
:
81-10129warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.time**MAY** be precise to the second (CONF:81-10129).
:
81-10130warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.authenticator:authenticator1.timeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ivl-ts-centererrorClinicalDocument.documentationOf.serviceEvent.effectiveTimeCenter cannot co-exist with low or high
: center.empty() or (low.empty() and high.empty())
pn-no-lserrorClinicalDocument.recordTarget.patientRole.patient.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalDocument 1..1USRealmHeaderXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, copyTime, recordTarget, author, dataEnterer, informant, custodian, informationRecipient, legalAuthenticator, authenticator, participant, inFulfillmentOf, documentationOf, relatedDocument, authorization, componentOf, component, realmCode, typeId, templateId, templateId, id, code, title, effectiveTime, confidentialityCode, languageCode, setId, versionNumber, recordTarget, author, dataEnterer, informant, informant, informant, custodian, informationRecipient, legalAuthenticator, authenticator, authenticator, participant, inFulfillmentOf, documentationOf, authorization, componentOf
Base for all types and resources
... @classCode 0..1csBinding: ActClass (extensible)
Fixed Value: DOCCLIN
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... realmCode 1..1CS
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: US
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... typeId 1..1II
.... @root 1..1stFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1stExtension
Fixed Value: POCD_HD000040
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:us-realm 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.1
..... @extension 1..1stRequired Pattern: 2023-05-01
.... templateId:secondary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.1.7
..... @extension 1..1stRequired Pattern: 2015-08-01
... id C1..1II
... code C1..1CEThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Binding: FHIRDocumentTypeCodes (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: SurgicalOperationNoteDocumentTypeCode (required)
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1STThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
... effectiveTime C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
... confidentialityCode 1..1CEBinding: HL7 BasicConfidentialityKind (preferred)
... languageCode 1..1CSBinding: VSAC 2.16.840.1.113883.1.11.11526 (required)
... setId C0..1II
... versionNumber C0..1INT
... copyTime 0..1TS
... recordTarget 1..*RecordTarget
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RCT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... patientRole 1..1PatientRole
..... @classCode 0..1csBinding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
..... templateId 0..*II
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... patient 1..1Patient
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... id 0..1II
...... name C1..*USRealmPatientNamePTNUSFIELDEDBase for all types and resources
...... sdtcDesc 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime C1..1TS
...... sdtcDeceasedInd C0..1BLXML Namespace: urn:hl7-org:sdtc
sdtc:deceasedInd
XML: deceasedInd (urn:hl7-org:sdtc)
...... sdtcDeceasedTime 0..1TSXML Namespace: urn:hl7-org:sdtc
sdtc:deceasedTime
XML: deceasedTime (urn:hl7-org:sdtc)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value C0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
...... sdtcMultipleBirthInd 0..1BLXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthInd (urn:hl7-org:sdtc)
...... sdtcMultipleBirthOrderNumber 0..1INT_POSXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
...... maritalStatusCode 0..1CEBinding: Marital Status (required)
...... religiousAffiliationCode 0..1CEBinding: Religious Affiliation (required)
...... raceCode 1..1CEBinding: Race Category Excluding Nulls (required)
...... sdtcRaceCode C0..*CEXML Namespace: urn:hl7-org:sdtc
The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.
XML: raceCode (urn:hl7-org:sdtc)
Binding: Race Value Set (required)
...... ethnicGroupCode 1..1CEBinding: Ethnicity (required)
...... sdtcEthnicGroupCode 0..*CEXML Namespace: urn:hl7-org:sdtc
ethnicGroupCode
XML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Detailed Ethnicity (required)
...... guardian 0..*Guardian
....... @classCode 0..1csBinding: RoleClassAgent (required)
Fixed Value: GUARD
....... templateId 0..*II
....... id 0..*II
....... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
....... code 0..1CEBinding: Personal And Legal Relationship Role Type (required)
....... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
....... telecom 0..*TEL
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @value 0..1url
........ useablePeriod 0..*
......... useablePeriodIVL_TS
......... useablePeriodEIVL_TS
......... useablePeriodPIVL_TS
......... useablePeriodSXPR_TS
........ @use 0..1csBinding: Telecom Use (US Realm Header) (required)
....... guardianPerson 1..1Person
........ @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
........ @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
........ templateId 0..*II
........ name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
........ sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
....... guardianOrganization 0..1Organization
...... birthplace 0..1Birthplace
....... @classCode 0..1csBinding: RoleClassPassive (required)
Fixed Value: BIRTHPL
....... templateId 0..*II
....... place 1..1Place
........ @classCode 0..1csBinding: EntityClassPlace (required)
Fixed Value: PLC
........ @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
........ templateId 0..*II
........ name 0..1EN
........ addr C1..1AD
......... nullFlavor C0..1csPrimitive Type code
Binding: NullFlavor (required)
......... @isNotOrdered 0..1bl
......... @use 0..*cs
......... delimiter 0..*ADXP
.......... @partType 0..1csFixed Value: DEL
......... country 0..1ADXP
.......... @partType 0..1csFixed Value: CNT
......... state 0..*ADXP
.......... @partType 0..1csFixed Value: STA
......... county 0..*ADXP
.......... @partType 0..1csFixed Value: CPA
......... city 0..*ADXP
.......... @partType 0..1csFixed Value: CTY
......... postalCode 0..*ADXP
.......... @partType 0..1csFixed Value: ZIP
......... streetAddressLine 0..*ADXP
.......... @partType 0..1csFixed Value: SAL
......... houseNumber 0..*ADXP
.......... @partType 0..1csFixed Value: BNR
......... houseNumberNumeric 0..*ADXP
.......... @partType 0..1csFixed Value: BNN
......... direction 0..*ADXP
.......... @partType 0..1csFixed Value: DIR
......... streetName 0..*ADXP
.......... @partType 0..1csFixed Value: STR
......... streetNameBase 0..*ADXP
.......... @partType 0..1csFixed Value: STB
......... streetNameType 0..*ADXP
.......... @partType 0..1csFixed Value: STTYP
......... additionalLocator 0..*ADXP
.......... @partType 0..1csFixed Value: ADL
......... unitID 0..*ADXP
.......... @partType 0..1csFixed Value: UNID
......... unitType 0..*ADXP
.......... @partType 0..1csFixed Value: UNIT
......... careOf 0..*ADXP
.......... @partType 0..1csFixed Value: CAR
......... censusTract 0..*ADXP
.......... @partType 0..1csFixed Value: CEN
......... deliveryAddressLine 0..*ADXP
.......... @partType 0..1csFixed Value: DAL
......... deliveryInstallationType 0..*ADXP
.......... @partType 0..1csFixed Value: DINST
......... deliveryInstallationArea 0..*ADXP
.......... @partType 0..1csFixed Value: DINSTA
......... deliveryInstallationQualifier 0..*ADXP
.......... @partType 0..1csFixed Value: DINSTQ
......... deliveryMode 0..*ADXP
.......... @partType 0..1csFixed Value: DMOD
......... deliveryModeIdentifier 0..*ADXP
.......... @partType 0..1csFixed Value: DMODID
......... buildingNumberSuffix 0..*ADXP
.......... @partType 0..1csFixed Value: BNS
......... postBox 0..*ADXP
.......... @partType 0..1csFixed Value: POB
......... precinct 0..*ADXP
.......... @partType 0..1csFixed Value: PRE
......... other 0..1st
......... useablePeriod 0..*
.......... useablePeriodIVL_TS
.......... useablePeriodEIVL_TS
.......... useablePeriodPIVL_TS
.......... useablePeriodSXPR_TS
...... languageCommunication 0..*LanguageCommunication
....... templateId 0..*II
....... languageCode 1..1CSBinding: VSAC 2.16.840.1.113883.1.11.11526 (required)
....... modeCode 0..1CEBinding: LanguageAbilityMode (required)
....... proficiencyLevelCode 0..1CEBinding: LanguageAbilityProficiency (required)
....... preferenceInd 0..1BL
..... providerOrganization 0..1Organization
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 1..*II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
...... name 1..*ON
...... telecom 1..*TEL
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value 0..1url
....... useablePeriod 0..*
........ useablePeriodIVL_TS
........ useablePeriodEIVL_TS
........ useablePeriodPIVL_TS
........ useablePeriodSXPR_TS
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
...... asOrganizationPartOf 0..1OrganizationPartOf
... author 1..*Author
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: AUT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CE
.... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
.... assignedAuthor C1..1AssignedAuthor
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... Slices for id 1..*IISlice: Unordered, Open by value:root
...... id:id1 0..1IIid
....... @nullFlavor 0..1csBinding: NullFlavor (required)
Fixed Value: UNK
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (extensible)
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @code 1..1csBinding: Healthcare Provider Taxonomy (preferred)
...... @codeSystem 0..1oid, uuid, ruid
...... @codeSystemName 0..1st
...... @codeSystemVersion 0..1st
...... @displayName 0..1st
...... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1ED
...... translation 0..*CD
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... assignedPerson 0..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... assignedAuthoringDevice 0..1AuthoringDevice
...... @classCode 0..1csBinding: EntityClassDevice (required)
Fixed Value: DEV
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... code 0..1CEBinding: EntityCode (extensible)
...... manufacturerModelName 1..1SCBinding: Manufacturer Model Name Example (example)
...... softwareName 1..1SCBinding: Software Name Example (example)
...... asMaintainedEntity 0..*MaintainedEntity
..... representedOrganization 0..1Organization
... dataEnterer 0..1DataEnterer
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: ENT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... time 1..1TS
.... assignedEntity 1..1AssignedEntity
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
...... @extension 0..1st
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... assignedPerson 1..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... representedOrganization 0..1Organization
... Slices for informant 0..*InformantSlice: Unordered, Open by value:relatedEntity
.... informant:informant1 0..*Informantinformant
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: INF
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... assignedEntity 1..1AssignedEntity
...... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
...... templateId 0..*II
...... id C1..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 0..*TEL
...... assignedPerson 1..1Person
....... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
....... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... representedOrganization 0..1Organization
..... relatedEntity 0..1RelatedEntity
.... informant:informant2 0..*Informantinformant
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: INF
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... assignedEntity 0..1AssignedEntity
..... relatedEntity 1..1RelatedEntity
... custodian 1..1Custodian
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: ENT
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... assignedCustodian 1..1AssignedCustodian
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... representedCustodianOrganization 1..1CustodianOrganization
...... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... id 1..*II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
...... name 1..1ON
...... telecom 1..1TEL
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value 0..1url
....... useablePeriod 0..*
........ useablePeriodIVL_TS
........ useablePeriodEIVL_TS
........ useablePeriodPIVL_TS
........ useablePeriodSXPR_TS
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... addr C1..1USRealmAddressADUSFIELDEDBase for all types and resources
... informationRecipient 0..*InformationRecipient
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... intendedRecipient 1..1IntendedRecipient
..... @classCode 1..1cs
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... addr 0..*AD
..... telecom 0..*TEL
..... informationRecipient 0..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... receivedOrganization 0..1Organization
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 0..*II
...... name 1..1ON
...... telecom 0..*TEL
...... addr 0..*AD
...... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
...... asOrganizationPartOf 0..1OrganizationPartOf
... legalAuthenticator 0..1LegalAuthenticator
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: LA
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
.... signatureCode 1..1CS
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @code 1..1csRequired Pattern: S
..... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
..... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
XML: signatureText (urn:hl7-org:sdtc)
.... assignedEntity 1..1AssignedEntity
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... templateId 0..*II
..... id 1..*II
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
...... @extension 0..1st
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
..... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
..... telecom 1..*TEL
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1url
...... useablePeriod 0..*
....... useablePeriodIVL_TS
....... useablePeriodEIVL_TS
....... useablePeriodPIVL_TS
....... useablePeriodSXPR_TS
...... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
..... assignedPerson 1..1Person
...... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
...... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
..... representedOrganization 0..1Organization
... Slices for authenticator 0..*AuthenticatorSlice: Unordered, Open by value:ClinicalDocument.signatureCode, value:ClinicalDocument.assignedEntity, value:ClinicalDocument.time
.... authenticator:authenticator1 0..*Authenticatorauthenticator
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: AUTHEN
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... time C1..1USRealmDateandTimeDTMUSFIELDEDBase for all types and resources
..... signatureCode 1..1CS
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @code 1..1csRequired Pattern: S
...... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
..... sdtcSignatureText 0..1EDXML Namespace: urn:hl7-org:sdtc
The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
XML: signatureText (urn:hl7-org:sdtc)
..... assignedEntity 1..1AssignedEntity
...... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
...... templateId 0..*II
...... id 1..*II
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
....... @extension 0..1st
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: v3 Code System RoleCode (extensible)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @code 0..1csBinding: Healthcare Provider Taxonomy (preferred)
....... @codeSystem 0..1oid, uuid, ruid
....... @codeSystemName 0..1st
....... @codeSystemVersion 0..1st
....... @displayName 0..1st
....... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
....... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
....... originalText 0..1ED
....... translation 0..*CD
...... addr C1..*USRealmAddressADUSFIELDEDBase for all types and resources
...... telecom 1..*TEL
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @value 0..1url
....... useablePeriod 0..*
........ useablePeriodIVL_TS
........ useablePeriodEIVL_TS
........ useablePeriodPIVL_TS
........ useablePeriodSXPR_TS
....... @use 0..1csBinding: Telecom Use (US Realm Header) (required)
...... assignedPerson 1..1Person
....... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
....... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... representedOrganization 0..1Organization
... participant C0..*Participant1
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... functionCode 0..1CE
.... time 0..1IVL_TS
.... associatedEntity 1..1AssociatedEntity
... inFulfillmentOf 0..*InFulfillmentOf
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: FLFS
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... order 1..1Order
..... @classCode 1..1csBinding: ActClass (required)
..... @moodCode 0..1csBinding: ActMoodIntent (required)
Fixed Value: RQO
..... templateId 0..*II
..... id 1..*II
..... code 0..1CEBinding: v3 Code System ActCode (extensible)
..... priorityCode 0..1CEBinding: ActPriority (extensible)
... documentationOf 1..*DocumentationOfA serviceEvent represents the main act, such as a colonoscopy or an appendectomy, being documented. A serviceEvent can further specialize the act inherent in the ClinicalDocument/code, such as where the ClinicalDocument/code is simply "Surgical Operation Note" and the procedure is "Appendectomy." serviceEvent is required in the Operative Note and it must be equivalent to or further specialize the value inherent in the ClinicalDocument/code; it shall not conflict with the value inherent in the ClinicalDocument/code, as such a conflict would create ambiguity. serviceEvent/effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place. If the date and the duration of the procedure is known, serviceEvent/effectiveTime/low is used with a width element that describes the duration; no high element is used. However, if only the date is known, the date is placed in both the low and high elements.
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: DOC
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... serviceEvent C1..1ServiceEvent1198-8487: The value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
..... @classCode 1..1csBinding: ActClass (required)
..... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id 0..*II
..... code 0..1CE
..... effectiveTime C1..1USRealmDateandTimeDTUSFIELDEDBase for all types and resources
1198-8488: The serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
1198-10058: If a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
1198-10060: When only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
...... @operator 0..1csBinding: SetOperator (required)
...... low 1..1IVXB_TS
...... center 0..1TS
...... width 0..1PQ
...... high 0..1IVXB_TS
..... Slices for performer 1..*Performer1This performer represents any assistants.
Slice: Unordered, Open by value:assignedEntity, value:typeCode, value:functionCode
...... performer:All Slices Content/Rules for all slices
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... functionCode 0..1CE
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @code 0..1csBinding: Care Team Member Function (preferred)
........ @codeSystem 0..1oid, uuid, ruid
........ @codeSystemName 0..1st
........ @codeSystemVersion 0..1st
........ @displayName 0..1st
........ @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
........ @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
........ originalText 0..1ED
........ translation 0..*CD
....... time 0..1IVL_TS
....... assignedEntity 1..1AssignedEntity
........ @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
........ templateId 0..*II
........ id 1..*II
......... @nullFlavor 0..1csBinding: NullFlavor (required)
......... @assigningAuthorityName 0..1st
......... @displayable 0..1bl
......... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
......... @extension 0..1st
........ sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
........ code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
........ addr 0..*AD
........ telecom 0..*TEL
........ assignedPerson 0..1Person
........ representedOrganization 0..1Organization
...... performer:performer1 1..*Performer1This performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: PPRF
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @code 0..1csBinding: Care Team Member Function (preferred)
........ @codeSystem 0..1oid, uuid, ruid
........ @codeSystemName 0..1st
........ @codeSystemVersion 0..1st
........ @displayName 0..1st
........ @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
........ @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
........ originalText 0..1ED
........ translation 0..*CD
....... time 0..1IVL_TS
....... assignedEntity 1..1AssignedEntity
........ @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
........ templateId 0..*II
........ id 1..*II
......... @nullFlavor 0..1csBinding: NullFlavor (required)
......... @assigningAuthorityName 0..1st
......... @displayable 0..1bl
......... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
......... @extension 0..1st
........ sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
........ addr 0..*AD
........ telecom 0..*TEL
........ assignedPerson 0..1Person
........ representedOrganization 0..1Organization
...... performer:performer2 0..*Performer1
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @typeCode 1..1csBinding: x_ServiceEventPerformer (required)
Fixed Value: SPRF
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... functionCode 0..1CEBinding: Care Team Member Function (preferred)
........ @nullFlavor 0..1csBinding: NullFlavor (required)
........ @code 0..1csBinding: Care Team Member Function (preferred)
........ @codeSystem 0..1oid, uuid, ruid
........ @codeSystemName 0..1st
........ @codeSystemVersion 0..1st
........ @displayName 0..1st
........ @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
........ @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
........ originalText 0..1ED
........ translation 0..*CD
....... time 0..1IVL_TS
....... assignedEntity 1..1AssignedEntity
........ @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
........ templateId 0..*II
........ id 1..*II
......... @nullFlavor 0..1csBinding: NullFlavor (required)
......... @assigningAuthorityName 0..1st
......... @displayable 0..1bl
......... @root 0..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
......... @extension 0..1st
........ sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
........ code 0..1CEBinding: Healthcare Provider Taxonomy (required)
........ addr 0..*AD
........ telecom 0..*TEL
........ assignedPerson 0..1Person
........ representedOrganization 0..1Organization
... relatedDocument 0..*RelatedDocument
... authorization 0..1AuthorizationAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: AUTH
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... consent 1..1Consent
..... @classCode 1..1csBinding: ActClass (required)
Fixed Value: CONS
..... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id 0..*II
..... code 0..1CEThe type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.
Binding: v3 Code System ActCode (extensible)
..... statusCode 1..1CSBinding: ActStatus (required)
...... @code 1..1csFixed Value: completed
... componentOf 0..1ComponentOf
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
Fixed Value: COMP
.... encompassingEncounter 1..1EncompassingEncounter
..... @classCode 0..1csBinding: ActClass (required)
Fixed Value: ENC
..... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
..... templateId 0..*II
..... id 1..*II
..... code 0..1CEBinding: ActEncounterCode (extensible)
..... effectiveTime 1..1IVL_TS
..... sdtcAdmissionReferralSourceCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: admissionReferralSourceCode (urn:hl7-org:sdtc)
..... dischargeDispositionCode 0..1CEBinding: USEncounterDischargeDisposition (extensible)
..... responsibleParty 0..1InfrastructureRoot
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: RESP
...... assignedEntity 1..1AssignedEntity
..... encounterParticipant 0..*EncounterParticipant
..... location 0..1InfrastructureRoot
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... @typeCode 0..1csBinding: ParticipationTargetLocation (required)
Fixed Value: LOC
...... healthCareFacility 1..1HealthCareFacility
... component 1..1Component
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
Fixed Value: COMP
.... @contextConductionInd 0..1blFixed Value: true
.... nonXMLBody 0..1NonXMLBody
.... structuredBody 1..1StructuredBody
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @classCode 0..1csBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCBODY
..... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
..... confidentialityCode 0..1CE
..... languageCode 0..1CSBinding: HumanLanguage (required)
..... Slices for component 8..*InfrastructureRootSlice: Unordered, Open by value:ClinicalDocument.section
...... component:All Slices Content/Rules for all slices
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1Section
...... component:component1 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1AnesthesiaSectionBase for all types and resources
...... component:component2 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ComplicationsSectionBase for all types and resources
...... component:component3 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PreoperativeDiagnosisSectionBase for all types and resources
...... component:component4 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1ProcedureEstimatedBloodLossSectionBase for all types and resources
...... component:component5 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureFindingsSectionBase for all types and resources
...... component:component6 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1ProcedureSpecimensTakenSectionBase for all types and resources
...... component:component7 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureDescriptionSectionBase for all types and resources
...... component:component8 1..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PostoperativeDiagnosisSectionBase for all types and resources
...... component:component9 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1ProcedureImplantsSectionBase for all types and resources
...... component:component10 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1OperativeNoteFluidsSectionBase for all types and resources
...... component:component11 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1OperativeNoteSurgicalProcedureSectionBase for all types and resources
...... component:component12 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PlanofTreatmentSectionBase for all types and resources
...... component:component13 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1PlannedProcedureSectionBase for all types and resources
...... component:component14 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureDispositionSectionBase for all types and resources
...... component:component15 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section 1..1ProcedureIndicationsSectionBase for all types and resources
...... component:component16 0..1InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csFixed Value: COMP
....... @contextConductionInd 0..1blFixed Value: true
....... section C1..1SurgicalDrainsSectionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ClinicalDocument.classCodeextensibleFixed Value: DOCCLIN
ClinicalDocument.moodCoderequiredFixed Value: EVN
ClinicalDocument.realmCode.nullFlavorrequiredNullFlavor
ClinicalDocument.templateId:us-realm.nullFlavorrequiredNullFlavor
ClinicalDocument.templateId:secondary.nullFlavorrequiredNullFlavor
ClinicalDocument.codeextensibleFHIRDocumentTypeCodes
ClinicalDocument.code.nullFlavorrequiredNullFlavor
ClinicalDocument.code.coderequiredSurgicalOperationNoteDocumentTypeCode
ClinicalDocument.confidentialityCodepreferredHL7 BasicConfidentialityKind
ClinicalDocument.languageCoderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526
ClinicalDocument.recordTarget.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.typeCoderequiredFixed Value: RCT
ClinicalDocument.recordTarget.contextControlCoderequiredFixed Value: OP
ClinicalDocument.recordTarget.patientRole.classCoderequiredFixed Value: PAT
ClinicalDocument.recordTarget.patientRole.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.patient.classCoderequiredFixed Value: PSN
ClinicalDocument.recordTarget.patientRole.patient.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)
ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCoderequiredMarital Status
ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCoderequiredReligious Affiliation
ClinicalDocument.recordTarget.patientRole.patient.raceCoderequiredRace Category Excluding Nulls
ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCoderequiredRace Value Set
ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCoderequiredEthnicity
ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCoderequiredDetailed Ethnicity
ClinicalDocument.recordTarget.patientRole.patient.guardian.classCoderequiredFixed Value: GUARD
ClinicalDocument.recordTarget.patientRole.patient.guardian.coderequiredPersonal And Legal Relationship Role Type
ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCoderequiredFixed Value: BIRTHPL
ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCoderequiredFixed Value: PLC
ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCoderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.11526
ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCoderequiredLanguageAbilityMode
ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCoderequiredLanguageAbilityProficiency
ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.providerOrganization.classCoderequiredFixed Value: ORG
ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS
ClinicalDocument.author.nullFlavorrequiredNullFlavor
ClinicalDocument.author.typeCoderequiredFixed Value: AUT
ClinicalDocument.author.contextControlCoderequiredFixed Value: OP
ClinicalDocument.author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.author.assignedAuthor.id:id1.nullFlavorrequiredFixed Value: UNK
ClinicalDocument.author.assignedAuthor.codeextensibleRoleCode
ClinicalDocument.author.assignedAuthor.code.nullFlavorrequiredNullFlavor
ClinicalDocument.author.assignedAuthor.code.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.author.assignedAuthor.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.author.assignedAuthor.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.author.assignedAuthor.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCoderequiredFixed Value: DEV
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.codeextensibleEntityCode
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelNameexampleManufacturerModelNameExample
ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareNameexampleSoftwareNameExample
ClinicalDocument.dataEnterer.nullFlavorrequiredNullFlavor
ClinicalDocument.dataEnterer.typeCoderequiredFixed Value: ENT
ClinicalDocument.dataEnterer.contextControlCoderequiredFixed Value: OP
ClinicalDocument.dataEnterer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.dataEnterer.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.dataEnterer.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informant:informant1.nullFlavorrequiredNullFlavor
ClinicalDocument.informant:informant1.typeCoderequiredFixed Value: INF
ClinicalDocument.informant:informant1.contextControlCoderequiredFixed Value: OP
ClinicalDocument.informant:informant1.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.informant:informant1.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informant:informant2.nullFlavorrequiredNullFlavor
ClinicalDocument.informant:informant2.typeCoderequiredFixed Value: INF
ClinicalDocument.informant:informant2.contextControlCoderequiredFixed Value: OP
ClinicalDocument.custodian.nullFlavorrequiredNullFlavor
ClinicalDocument.custodian.typeCoderequiredFixed Value: ENT
ClinicalDocument.custodian.assignedCustodian.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCoderequiredFixed Value: ORG
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavorrequiredNullFlavor
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.informationRecipient.nullFlavorrequiredNullFlavor
ClinicalDocument.informationRecipient.typeCoderequiredParticipationType
ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCoderequiredFixed Value: PSN
ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavorrequiredNullFlavor
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCoderequiredFixed Value: ORG
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS
ClinicalDocument.legalAuthenticator.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.typeCoderequiredFixed Value: LA
ClinicalDocument.legalAuthenticator.contextControlCoderequiredFixed Value: OP
ClinicalDocument.legalAuthenticator.signatureCode.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.legalAuthenticator.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.authenticator:authenticator1.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.typeCoderequiredFixed Value: AUTHEN
ClinicalDocument.authenticator:authenticator1.signatureCode.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.authenticator:authenticator1.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.codeextensibleRoleCode
ClinicalDocument.authenticator:authenticator1.assignedEntity.code.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.nullFlavorrequiredNullFlavor
ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.userequiredTelecom Use (US Realm Header)
ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCoderequiredFixed Value: PSN
ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
ClinicalDocument.participant.nullFlavorrequiredNullFlavor
ClinicalDocument.participant.typeCoderequiredParticipationType
ClinicalDocument.participant.contextControlCoderequiredFixed Value: OP
ClinicalDocument.inFulfillmentOf.nullFlavorrequiredNullFlavor
ClinicalDocument.inFulfillmentOf.typeCoderequiredFixed Value: FLFS
ClinicalDocument.inFulfillmentOf.order.classCoderequiredActClass
ClinicalDocument.inFulfillmentOf.order.moodCoderequiredFixed Value: RQO
ClinicalDocument.inFulfillmentOf.order.codeextensibleActCode
ClinicalDocument.inFulfillmentOf.order.priorityCodeextensibleActPriority
ClinicalDocument.documentationOf.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.typeCoderequiredFixed Value: DOC
ClinicalDocument.documentationOf.serviceEvent.classCoderequiredActClass
ClinicalDocument.documentationOf.serviceEvent.moodCoderequiredFixed Value: EVN
ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operatorrequiredSetOperator
ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer.typeCoderequiredx_ServiceEventPerformer
ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCoderequiredFixed Value: PPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.codepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.typeCoderequiredFixed Value: SPRF
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCodepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.codepreferredCare Team Member Function
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.classCoderequiredFixed Value: ASSIGNED
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id.nullFlavorrequiredNullFlavor
ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.coderequiredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
ClinicalDocument.authorization.nullFlavorrequiredNullFlavor
ClinicalDocument.authorization.typeCoderequiredFixed Value: AUTH
ClinicalDocument.authorization.consent.classCoderequiredFixed Value: CONS
ClinicalDocument.authorization.consent.moodCoderequiredFixed Value: EVN
ClinicalDocument.authorization.consent.codeextensibleActCode
ClinicalDocument.authorization.consent.statusCoderequiredActStatus
ClinicalDocument.componentOf.nullFlavorrequiredNullFlavor
ClinicalDocument.componentOf.typeCoderequiredFixed Value: COMP
ClinicalDocument.componentOf.encompassingEncounter.classCoderequiredFixed Value: ENC
ClinicalDocument.componentOf.encompassingEncounter.moodCoderequiredFixed Value: EVN
ClinicalDocument.componentOf.encompassingEncounter.codeextensibleActEncounterCode
ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCodeextensibleUSEncounterDischargeDisposition
ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavorrequiredNullFlavor
ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCoderequiredFixed Value: RESP
ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavorrequiredNullFlavor
ClinicalDocument.componentOf.encompassingEncounter.location.typeCoderequiredFixed Value: LOC
ClinicalDocument.component.nullFlavorrequiredNullFlavor
ClinicalDocument.component.typeCoderequiredFixed Value: COMP
ClinicalDocument.component.structuredBody.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.classCoderequiredFixed Value: DOCBODY
ClinicalDocument.component.structuredBody.moodCoderequiredFixed Value: EVN
ClinicalDocument.component.structuredBody.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
ClinicalDocument.component.structuredBody.component.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component1.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component2.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component3.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component4.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component5.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component6.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component7.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component8.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component9.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component10.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component11.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component12.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component13.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component14.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component15.nullFlavorrequiredNullFlavor
ClinicalDocument.component.structuredBody.component:component16.nullFlavorrequiredNullFlavor

Constraints

IdGradePath(s)DetailsRequirements
1198-8487errorClinicalDocument.documentationOf.serviceEventThe value of serviceEvent/code **SHALL** be from ICD9 CM Procedures (CodeSystem 2.16.840.1.113883.6.104), CPT-4 (CodeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (CodeSystem 2.16.840.1.113883.6.96) ValueSet Procedure 2.16.840.1.113883.3.88.12.80.28 *DYNAMIC* (CONF:1198-8487).
:
1198-8488errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeThe serviceEvent/effectiveTime **SHALL** be present with effectiveTime/low (CONF:1198-8488).
:
1198-10058errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf a width is not present, the serviceEvent/effectiveTime **SHALL** include effectiveTime/high (CONF:1198-10058).
:
1198-10060errorClinicalDocument.documentationOf.serviceEvent.effectiveTimeWhen only the date and the length of the procedure are known a width element **SHALL** be present and the serviceEvent/effectiveTime/high **SHALL NOT** be present (CONF:1198-10060).
:
4537-5299errorClinicalDocument.recordTarget.patientRole.patient.birthTime**SHALL** be precise to year (CONF:4537-5299).
:
4537-5300warningClinicalDocument.recordTarget.patientRole.patient.birthTime**SHOULD** be precise to day (CONF:4537-5300).
:
4537-5402warningClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addrIf country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:4537-5402).
:
4537-5403warningClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addrIf country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403).
:
4537-6380errorClinicalDocument.setIdIf setId is present versionNumber **SHALL** be present (CONF:4537-6380).
:
4537-6387errorClinicalDocument.versionNumberIf versionNumber is present setId **SHALL** be present (CONF:4537-6387).
:
4537-9946warningClinicalDocument.informant:informant1.assignedEntity.idIf assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946).
:
4537-9991warningClinicalDocument.idThis id **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
:
4537-9992errorClinicalDocument.codeThis code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
:
4537-10006errorClinicalDocument.participant**SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006).
:
4537-10007warningClinicalDocument.participantWhen participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007).
:
4537-16790errorClinicalDocument.author.assignedAuthorThere **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790).
:
4537-31347errorClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCodeIf sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347).
:
4537-32418warningClinicalDocument.recordTarget.patientRole.patient.birthTime**MAY** be precise to the minute (CONF:4537-32418).
:
4537-32948errorClinicalDocument.codeThis code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948).
:
4537-32991errorClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.value**SHALL** be precise to to the year (CONF:4537-32991).
:
4537-32992warningClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.value**SHOULD** be precise to the day (CONF:4537-32992).
:
4537-32993errorClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedIndIf sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993).
:
81-7278errorClinicalDocument.recordTarget.patientRole.patient.name**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:
81-7296errorClinicalDocument.recordTarget.patientRole.addr, ClinicalDocument.recordTarget.patientRole.patient.guardian.addr, ClinicalDocument.recordTarget.patientRole.providerOrganization.addr, ClinicalDocument.author.assignedAuthor.addr, ClinicalDocument.dataEnterer.assignedEntity.addr, ClinicalDocument.informant:informant1.assignedEntity.addr, ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr, ClinicalDocument.legalAuthenticator.assignedEntity.addr, ClinicalDocument.authenticator:authenticator1.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-8052warningClinicalDocument.component.structuredBody.component:component10.sectionIf the Operative Note Fluids section is present, there SHALL be a statement providing details of the fluids administered or SHALL explicitly state there were no fluids administered (CONF:81-8052).
:
81-8054warningClinicalDocument.component.structuredBody.component:component11.sectionIf the surgical procedure section is present there SHALL be text indicating the procedure performed (CONF:81-8054).
:
81-8056warningClinicalDocument.component.structuredBody.component:component16.sectionIf the Surgical Drains section is present, there SHALL be a statement providing details of the drains placed or SHALL explicitly state there were no drains placed (CONF:81-8056).
:
81-8741warningClinicalDocument.component.structuredBody.component:component4.sectionThe Estimated Blood Loss section SHALL include a statement providing an estimate of the amount of blood lost during the procedure, even if the estimate is text, such as "minimal" or "none" (CONF:81-8741).
:
81-8742warningClinicalDocument.component.structuredBody.component:component6.sectionThe Procedure Specimens Taken section SHALL list all specimens removed or SHALL explicitly state that no specimens were taken (CONF:81-8742).
:
81-8769errorClinicalDocument.component.structuredBody.component:component9.sectionThe Procedure Implants section **SHALL** include a statement providing details of the implants placed, or assert no implants were placed (CONF:81-8769).
:
81-9371errorClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
81-10078errorClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHALL** be precise to the day (CONF:81-10078).
:
81-10079warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**SHOULD** be precise to the minute (CONF:81-10079).
:
81-10080warningClinicalDocument.documentationOf.serviceEvent.effectiveTime**MAY** be precise to the second (CONF:81-10080).
:
81-10081warningClinicalDocument.documentationOf.serviceEvent.effectiveTimeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10081).
:
81-10127errorClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.time**SHALL** be precise to the day (CONF:81-10127).
:
81-10128warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.time**SHOULD** be precise to the minute (CONF:81-10128).
:
81-10129warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.time**MAY** be precise to the second (CONF:81-10129).
:
81-10130warningClinicalDocument.effectiveTime, ClinicalDocument.author.time, ClinicalDocument.legalAuthenticator.time, ClinicalDocument.authenticator:authenticator1.timeIf more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).
:
cs-patternerrorClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavorcs attributes must not contain any whitespace
: matches('^[^\\s]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ivl-ts-centererrorClinicalDocument.documentationOf.serviceEvent.effectiveTimeCenter cannot co-exist with low or high
: center.empty() or (low.empty() and high.empty())
pn-no-lserrorClinicalDocument.recordTarget.patientRole.patient.name, ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name, ClinicalDocument.author.assignedAuthor.assignedPerson.name, ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name, ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name, ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name, ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name, ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

This structure is derived from USRealmHeader

Summary

Mandatory: 16 elements (3 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element ClinicalDocument.documentationOf.serviceEvent.performer is sliced based on the values of value:assignedEntity, value:typeCode, value:functionCode
  • The element ClinicalDocument.component.structuredBody.component is sliced based on the value of value:ClinicalDocument.section

 

Other representations of profile: CSV, Excel