Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.29.1 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. ClinicalDocument | |
| 2. ClinicalDocument.templateId | |
| Slicing | This element introduces a set of slices on ClinicalDocument.templateId. The slices are and , and can be differentiated using the following discriminators:
|
| 3. ClinicalDocument.templateId:secondary | |
| SliceName | secondary |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1198-28458) such that it |
| Invariants | Defined on this element 1198-32945: When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32945). (: null) |
| 4. ClinicalDocument.templateId:secondary.root | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.29.1" (CONF:1198-28459). |
| Pattern Value | 2.16.840.1.113883.10.20.29.1 |
| 5. ClinicalDocument.templateId:secondary.extension | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32917). |
| Pattern Value | 2015-08-01 |
| 6. ClinicalDocument.recordTarget | |
| Control | 1..1* |
| Requirements | SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460). SHALL contain at least one [1..*] recordTarget (CONF:1198-5266). |
| 7. ClinicalDocument.recordTarget.patientRole | |
| Requirements | This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461). Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:1198-5267). |
| 8. ClinicalDocument.recordTarget.patientRole.id | |
| Requirements | This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462). This patientRole SHALL contain at least one [1..*] id (CONF:1198-5268). |
| 9. ClinicalDocument.recordTarget.patientRole.patient | |
| Requirements | This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465). This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-5283). |
| 10. ClinicalDocument.recordTarget.patientRole.patient.guardian | |
| Requirements | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469). This patient MAY contain zero or more [0..*] guardian (CONF:1198-5325). |
| 11. ClinicalDocument.recordTarget.patientRole.patient.guardian.id | |
| Requirements | The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470). |
| 12. ClinicalDocument.recordTarget.patientRole.patient.guardian.code | |
| Requirements | The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28473). The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-5326). |
| 13. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | |
| Requirements | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-28474). This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-5406). |
| 14. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd | |
| Requirements | The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:1198-28475). The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:1198-5414). |
| 15. ClinicalDocument.recordTarget.patientRole.providerOrganization | |
| Requirements | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476). This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-5416). |
| 16. ClinicalDocument.author | |
| Requirements | SHALL contain at least one [1..*] author (CONF:1198-28477). SHALL contain at least one [1..*] author (CONF:1198-5444). |
| 17. ClinicalDocument.author.assignedAuthor | |
| Requirements | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478). Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-5448). |
| 18. ClinicalDocument.author.assignedAuthor.id | |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479). |
| 19. ClinicalDocument.author.assignedAuthor.code | |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-28481). This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-16787). |
| 20. ClinicalDocument.author.assignedAuthor.code.code | |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role TypeThe codes SHOULD be taken from Healthcare Provider Taxonomy |
| Requirements | The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28676). The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-16788). |
| 21. ClinicalDocument.dataEnterer | |
| Requirements | MAY contain zero or one [0..1] dataEnterer (CONF:1198-28678). MAY contain zero or one [0..1] dataEnterer (CONF:1198-5441). |
| 22. ClinicalDocument.dataEnterer.assignedEntity | |
| Requirements | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679). The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-5442). |
| 23. ClinicalDocument.dataEnterer.assignedEntity.code | |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role TypeThe codes SHOULD be taken from Healthcare Provider Taxonomy |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680). This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-32173). |
| 24. ClinicalDocument.informant | |
| Slicing | This element introduces a set of slices on ClinicalDocument.informant. The slices are and , and can be differentiated using the following discriminators:
|
| 25. ClinicalDocument.informant:informant1 | |
| SliceName | informant1 |
| Requirements | MAY contain zero or more [0..*] informant (CONF:1198-28681) such that it MAY contain zero or more [0..*] informant (CONF:1198-8001) such that it |
| 26. ClinicalDocument.informant:informant1.relatedEntity | |
| Control | 10..1 |
| Requirements | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682). |
| 27. ClinicalDocument.informant:informant1.relatedEntity.code | |
| Control | 0..1 |
| Requirements | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683). |
| 28. ClinicalDocument.informant:informant1.relatedEntity.code.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Requirements | The code, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28684). |
| 29. ClinicalDocument.custodian | |
| Requirements | SHALL contain exactly one [1..1] custodian (CONF:1198-28685). SHALL contain exactly one [1..1] custodian (CONF:1198-5519). |
| 30. ClinicalDocument.custodian.assignedCustodian | |
| Requirements | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686). This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-5520). |
| 31. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization | |
| Requirements | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-28687). This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-5521). |
| 32. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id | |
| Requirements | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-28688). This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-5522). |
| 33. ClinicalDocument.informationRecipient | |
| Requirements | MAY contain zero or more [0..*] informationRecipient (CONF:1198-28690). MAY contain zero or more [0..*] informationRecipient (CONF:1198-5565). |
| 34. ClinicalDocument.informationRecipient.intendedRecipient | |
| Requirements | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691). The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-5566). |
| 35. ClinicalDocument.informationRecipient.intendedRecipient.id | |
| Requirements | This intendedRecipient SHOULD contain zero or more [0..*] id (CONF:1198-28692). This intendedRecipient MAY contain zero or more [0..*] id (CONF:1198-32399). |
| 36. ClinicalDocument.informationRecipient.intendedRecipient.id.root | |
| Control | 0..1 |
| Requirements | The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693). |
| 37. ClinicalDocument.legalAuthenticator | |
| Requirements | MAY contain zero or one [0..1] legalAuthenticator (CONF:1198-28694). SHOULD contain zero or one [0..1] legalAuthenticator (CONF:1198-5579). |
| 38. ClinicalDocument.legalAuthenticator.assignedEntity | |
| Requirements | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695). The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-5585). |
| 39. ClinicalDocument.legalAuthenticator.assignedEntity.id | |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28696). This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5586). |
| 40. ClinicalDocument.legalAuthenticator.assignedEntity.code | |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697). This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-17000). |
| 41. ClinicalDocument.legalAuthenticator.assignedEntity.code.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Requirements | The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28698). |
| 42. ClinicalDocument.authenticator | |
| Requirements | MAY contain zero or more [0..*] authenticator (CONF:1198-28699). |
| 43. ClinicalDocument.authenticator.assignedEntity | |
| Control | 1..1 |
| Requirements | The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700). |
| 44. ClinicalDocument.authenticator.assignedEntity.id | |
| Control | 1..* |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701). |
| 45. ClinicalDocument.authenticator.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Requirements | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702). |
| 46. ClinicalDocument.participant | |
| Requirements | MAY contain zero or more [0..*] participant (CONF:1198-28703). |
| 47. ClinicalDocument.participant.typeCode | |
| Control | 1..1 |
| Requirements | The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704). |
| 48. ClinicalDocument.participant.associatedEntity | |
| Control | 1..1 |
| Requirements | The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705). |
| 49. ClinicalDocument.participant.associatedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Requirements | This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706). |
| 50. ClinicalDocument.inFulfillmentOf | |
| Requirements | MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707). MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-9952). |
| 51. ClinicalDocument.inFulfillmentOf.order | |
| Requirements | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708). The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-9953). |
| 52. ClinicalDocument.inFulfillmentOf.order.id | |
| Requirements | This order SHALL contain at least one [1..*] id (CONF:1198-28709). This order SHALL contain at least one [1..*] id (CONF:1198-9954). |
| 53. ClinicalDocument.documentationOf | |
| Requirements | MAY contain zero or more [0..*] documentationOf (CONF:1198-28710). MAY contain zero or more [0..*] documentationOf (CONF:1198-14835). |
| 54. ClinicalDocument.documentationOf.serviceEvent | |
| Requirements | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711). The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-14836). |
| 55. ClinicalDocument.documentationOf.serviceEvent.code | |
| Requirements | This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712). |
| 56. ClinicalDocument.documentationOf.serviceEvent.performer | |
| Requirements | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713). This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-14839). |
| 57. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | |
| Requirements | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-28714). The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818). |
| 58. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | |
| Requirements | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715). The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-14841). |
| 59. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id | |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716). This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-14846). |
| 60. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code | |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role TypeThe codes SHOULD be taken from Healthcare Provider Taxonomy |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718). This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-14842). |
Guidance on how to interpret the contents of this table can be found here.
| 1. ClinicalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. ClinicalDocument.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass; other codes may be used where these codes are not suitable |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | DOCCLIN |
| Fixed Value | DOCCLIN |
| 3. ClinicalDocument.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. ClinicalDocument.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] realmCode="US" (CONF:1198-16791). |
| Pattern Value | US |
| 5. ClinicalDocument.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] typeId (CONF:1198-5361). |
| 6. ClinicalDocument.typeId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:1198-5250). |
| Pattern Value | 2.16.840.1.113883.1.3 |
| 7. ClinicalDocument.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:1198-5251). |
| Pattern Value | POCD_HD000040 |
| 8. ClinicalDocument.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ClinicalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 9. ClinicalDocument.templateId:primary | |
| SliceName | primary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1198-5252) such that it |
| 10. ClinicalDocument.templateId:primary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:1198-10036). |
| Pattern Value | 2.16.840.1.113883.10.20.22.1.1 |
| 11. ClinicalDocument.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32503). |
| Pattern Value | 2015-08-01 |
| 12. ClinicalDocument.templateId:secondary | |
| SliceName | secondary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1198-28458) such that it |
| Invariants | Defined on this element 1198-32945: When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32945). (: null) |
| 13. ClinicalDocument.templateId:secondary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.29.1" (CONF:1198-28459). |
| Pattern Value | 2.16.840.1.113883.10.20.29.1 |
| 14. ClinicalDocument.templateId:secondary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32917). |
| Pattern Value | 2015-08-01 |
| 15. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] id (CONF:1198-5363). |
| Invariants | Defined on this element 1198-9991: This id **SHALL** be a globally unique identifier for the document (CONF:1198-9991). (: null) |
| 16. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1198-5253). |
| Invariants | Defined on this element 1198-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:1198-9992). (: null) 1198-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:1198-32948). (: null) |
| 17. ClinicalDocument.title | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
| Requirements | SHALL contain exactly one [1..1] title (CONF:1198-5254). |
| 18. ClinicalDocument.effectiveTime | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5256). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: null) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: null) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: null) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 19. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:1198-5259). |
| 20. ClinicalDocument.languageCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5372). |
| 21. ClinicalDocument.recordTarget | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RecordTarget |
| Requirements | SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460). |
| 22. ClinicalDocument.recordTarget.patientRole | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PatientRole |
| Requirements | This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461). |
| 23. ClinicalDocument.recordTarget.patientRole.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassRelationshipFormal |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PAT |
| Fixed Value | PAT |
| 24. ClinicalDocument.recordTarget.patientRole.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462). |
| 25. ClinicalDocument.recordTarget.patientRole.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5271). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 26. ClinicalDocument.recordTarget.patientRole.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This patientRole SHALL contain at least one [1..*] telecom (CONF:1198-5280). |
| 27. ClinicalDocument.recordTarget.patientRole.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-5375). |
| 28. ClinicalDocument.recordTarget.patientRole.patient | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Patient |
| Requirements | This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465). |
| 29. ClinicalDocument.recordTarget.patientRole.patient.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 30. ClinicalDocument.recordTarget.patientRole.patient.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 31. ClinicalDocument.recordTarget.patientRole.patient.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the individual. |
| Control | 10..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPatientNamePTNUSFIELDED) |
| Requirements | This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:1198-5284). Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name. |
| Invariants | Defined on this element 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 32. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Administrative Gender (HL7 V3) |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-6394). |
| 33. ClinicalDocument.recordTarget.patientRole.patient.birthTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This patient SHALL contain exactly one [1..1] birthTime (CONF:1198-5298). |
| Invariants | Defined on this element 1198-5299: **SHALL** be precise to year (CONF:1198-5299). (: null) 1198-5300: **SHOULD** be precise to day (CONF:1198-5300). (: null) 1198-32418: **MAY** be precise to the minute (CONF:1198-32418). For cases where information about newborn's time of birth needs to be captured. (: null) |
| 34. ClinicalDocument.recordTarget.patientRole.patient.raceCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Race Category Excluding Nulls |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:1198-5322). |
| 35. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Ethnicity |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:1198-5323). |
| 36. ClinicalDocument.recordTarget.patientRole.patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Guardian |
| Requirements | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469). |
| 37. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAgent |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | GUARD |
| Fixed Value | GUARD |
| 38. ClinicalDocument.recordTarget.patientRole.patient.guardian.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470). |
| 39. ClinicalDocument.recordTarget.patientRole.patient.guardian.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28473). |
| 40. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:1198-5385). |
| 41. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 42. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 43. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person. |
| Control | 10..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPersonNamePNUSFIELDED) |
| Requirements | This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5386). Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Comments | Person may have multiple names with different uses or applicable periods. |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: null) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 44. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication |
| Requirements | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-28474). |
| 45. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5407). |
| 46. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| Requirements | The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:1198-28475). |
| 47. ClinicalDocument.recordTarget.patientRole.providerOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| Requirements | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476). |
| 48. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ORG |
| Fixed Value | ORG |
| 49. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 50. ClinicalDocument.recordTarget.patientRole.providerOrganization.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Control | 10..*1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IIid |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:1198-5417). |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| 51. ClinicalDocument.recordTarget.patientRole.providerOrganization.name | |
| Definition | A name associated with the organization. |
| Control | 10..*1 This element is affected by the following invariants: org-1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ONstring |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:1198-5419). Need to use the name as the label of the organization. |
| Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
| 52. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:1198-5420). |
| 53. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7994). |
| 54. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5422). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 55. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| Requirements | SHALL contain at least one [1..*] author (CONF:1198-28477). |
| 56. ClinicalDocument.author.time | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5445). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: null) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: null) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: null) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 57. ClinicalDocument.author.assignedAuthor | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor |
| Requirements | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478). |
| Invariants | Defined on this element 1198-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:1198-16790). (: null) |
| 58. ClinicalDocument.author.assignedAuthor.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 59. ClinicalDocument.author.assignedAuthor.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479). |
| Invariants | Defined on this element 1198-5449: If this assignedAuthor is not an assignedPerson, this assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-5449). (: null) |
| Slicing | This element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 60. ClinicalDocument.author.assignedAuthor.id:id1 | |
| SliceName | id1 |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:1198-32882) such that it |
| 61. ClinicalDocument.author.assignedAuthor.id:id1.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32884). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 62. ClinicalDocument.author.assignedAuthor.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-28481). |
| 63. ClinicalDocument.author.assignedAuthor.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28676). |
| 64. ClinicalDocument.author.assignedAuthor.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 65. ClinicalDocument.author.assignedAuthor.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5452). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 66. ClinicalDocument.author.assignedAuthor.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:1198-5428). |
| 67. ClinicalDocument.author.assignedAuthor.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7995). |
| 68. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DataEnterer |
| Requirements | MAY contain zero or one [0..1] dataEnterer (CONF:1198-28678). |
| 69. ClinicalDocument.dataEnterer.time | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 70. ClinicalDocument.dataEnterer.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679). |
| 71. ClinicalDocument.dataEnterer.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 72. ClinicalDocument.dataEnterer.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5443). |
| 73. ClinicalDocument.dataEnterer.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680). |
| 74. ClinicalDocument.dataEnterer.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5460). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 75. ClinicalDocument.dataEnterer.assignedEntity.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5466). |
| 76. ClinicalDocument.dataEnterer.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7996). |
| 77. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-5469). |
| 78. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 79. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 80. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person. |
| Control | 10..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5470). Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Comments | Person may have multiple names with different uses or applicable periods. |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: null) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 81. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| Slicing | This element introduces a set of slices on ClinicalDocument.informant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 82. ClinicalDocument.informant:informant1 | |
| SliceName | informant1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| Requirements | MAY contain zero or more [0..*] informant (CONF:1198-28681) such that it |
| 83. ClinicalDocument.informant:informant1.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8002). |
| 84. ClinicalDocument.informant:informant1.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 85. ClinicalDocument.informant:informant1.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-9945). |
| Invariants | Defined on this element 1198-9946: If 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:1198-9946). (: null) |
| 86. ClinicalDocument.informant:informant1.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-8220). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 87. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-8221). |
| 88. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 89. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 90. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person. |
| Control | 10..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-8222). Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Comments | Person may have multiple names with different uses or applicable periods. |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: null) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 91. ClinicalDocument.informant:informant1.relatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| Requirements | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682). |
| 92. ClinicalDocument.informant:informant1.relatedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassMutualRelationship |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 93. ClinicalDocument.informant:informant1.relatedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from PersonalRelationshipRoleType; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683). |
| 94. ClinicalDocument.informant:informant1.relatedEntity.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The code, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28684). |
| 95. ClinicalDocument.informant:informant1.relatedEntity.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 96. ClinicalDocument.informant:informant2 | |
| SliceName | informant2 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| Requirements | MAY contain zero or more [0..*] informant (CONF:1198-31355) such that it |
| 97. ClinicalDocument.informant:informant2.relatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| Requirements | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-31356). |
| 98. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Custodian |
| Requirements | SHALL contain exactly one [1..1] custodian (CONF:1198-28685). |
| 99. ClinicalDocument.custodian.assignedCustodian | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedCustodian |
| Requirements | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686). |
| 100. ClinicalDocument.custodian.assignedCustodian.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 101. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CustodianOrganization |
| Requirements | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-28687). |
| 102. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ORG |
| Fixed Value | ORG |
| 103. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 104. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-28688). |
| 105. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ON |
| Requirements | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:1198-5524). |
| 106. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:1198-5525). |
| 107. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7998). |
| 108. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5559). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 109. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient |
| Requirements | MAY contain zero or more [0..*] informationRecipient (CONF:1198-28690). |
| 110. ClinicalDocument.informationRecipient.intendedRecipient | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IntendedRecipient |
| Requirements | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691). |
| 111. ClinicalDocument.informationRecipient.intendedRecipient.classCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| 112. ClinicalDocument.informationRecipient.intendedRecipient.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This intendedRecipient SHOULD contain zero or more [0..*] id (CONF:1198-28692). |
| 113. ClinicalDocument.informationRecipient.intendedRecipient.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693). |
| 114. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator |
| Requirements | MAY contain zero or one [0..1] legalAuthenticator (CONF:1198-28694). |
| 115. ClinicalDocument.legalAuthenticator.time | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5580). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: null) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: null) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: null) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 116. ClinicalDocument.legalAuthenticator.signatureCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:1198-5583). |
| 117. ClinicalDocument.legalAuthenticator.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5584). |
| Pattern Value | S |
| 118. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 119. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 120. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 121. ClinicalDocument.legalAuthenticator.signatureCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 122. ClinicalDocument.legalAuthenticator.signatureCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 123. ClinicalDocument.legalAuthenticator.signatureCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 124. ClinicalDocument.legalAuthenticator.signatureCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 125. ClinicalDocument.legalAuthenticator.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695). |
| 126. ClinicalDocument.legalAuthenticator.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 127. ClinicalDocument.legalAuthenticator.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28696). |
| 128. ClinicalDocument.legalAuthenticator.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697). |
| 129. ClinicalDocument.legalAuthenticator.assignedEntity.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28698). |
| 130. ClinicalDocument.legalAuthenticator.assignedEntity.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 131. ClinicalDocument.legalAuthenticator.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5589). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 132. ClinicalDocument.legalAuthenticator.assignedEntity.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5595). |
| 133. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7999). |
| 134. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-5597). |
| 135. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 136. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 137. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person. |
| Control | 10..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5598). Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Comments | Person may have multiple names with different uses or applicable periods. |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: null) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 138. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authenticator |
| Requirements | MAY contain zero or more [0..*] authenticator (CONF:1198-28699). |
| Slicing | This element introduces a set of slices on ClinicalDocument.authenticator. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 139. ClinicalDocument.authenticator.time | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 140. ClinicalDocument.authenticator.signatureCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 141. ClinicalDocument.authenticator.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700). |
| 142. ClinicalDocument.authenticator.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 143. ClinicalDocument.authenticator.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701). |
| 144. ClinicalDocument.authenticator.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702). |
| 145. ClinicalDocument.authenticator:authenticator1 | |
| SliceName | authenticator1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authenticator |
| Requirements | MAY contain zero or more [0..*] authenticator (CONF:1198-5607) such that it |
| 146. ClinicalDocument.authenticator:authenticator1.time | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5608). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: null) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: null) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: null) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 147. ClinicalDocument.authenticator:authenticator1.signatureCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] signatureCode (CONF:1198-5610). |
| 148. ClinicalDocument.authenticator:authenticator1.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5611). |
| Pattern Value | S |
| 149. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 150. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 151. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 152. ClinicalDocument.authenticator:authenticator1.signatureCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 153. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 154. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 155. ClinicalDocument.authenticator:authenticator1.signatureCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 156. ClinicalDocument.authenticator:authenticator1.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1198-5612). |
| 157. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 158. ClinicalDocument.authenticator:authenticator1.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5613). |
| 159. ClinicalDocument.authenticator:authenticator1.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5616). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 160. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5622). |
| 161. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-8000). |
| 162. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-5624). |
| 163. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 164. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 165. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person. |
| Control | 10..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5625). Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Comments | Person may have multiple names with different uses or applicable periods. |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: null) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 166. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant1 |
| Requirements | MAY contain zero or more [0..*] participant (CONF:1198-28703). |
| Slicing | This element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and defines no discriminators to differentiate the slices |
| 167. ClinicalDocument.participant:participant1 | |
| SliceName | participant1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant1 |
| Requirements | MAY contain zero or more [0..*] participant (CONF:1198-10003) such that it |
| Invariants | Defined on this element 1198-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:1198-10006). (: null) 1198-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *STATIC 2011-09-30* (CONF:1198-10007). (: null) |
| 168. ClinicalDocument.participant:participant1.associatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity |
| 169. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf |
| Requirements | MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707). |
| 170. ClinicalDocument.inFulfillmentOf.order | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Order |
| Requirements | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708). |
| 171. ClinicalDocument.inFulfillmentOf.order.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ACT |
| 172. ClinicalDocument.inFulfillmentOf.order.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMoodIntent |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | RQO |
| Fixed Value | RQO |
| 173. ClinicalDocument.inFulfillmentOf.order.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This order SHALL contain at least one [1..*] id (CONF:1198-28709). |
| 174. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DocumentationOf |
| Requirements | MAY contain zero or more [0..*] documentationOf (CONF:1198-28710). |
| 175. ClinicalDocument.documentationOf.serviceEvent | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ServiceEvent |
| Requirements | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711). |
| 176. ClinicalDocument.documentationOf.serviceEvent.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ACT |
| 177. ClinicalDocument.documentationOf.serviceEvent.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 178. ClinicalDocument.documentationOf.serviceEvent.code | |
| Definition | Drawn from concept domain ActCode |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712). |
| 179. ClinicalDocument.documentationOf.serviceEvent.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Requirements | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-14837). |
| 180. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-14838). |
| 181. ClinicalDocument.documentationOf.serviceEvent.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer1 |
| Requirements | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713). |
| 182. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ServiceEventPerformer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:1198-14840). |
| Fixed Value | DOC |
| 183. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-28714). |
| 184. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 185. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715). |
| 186. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 187. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716). |
| 188. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718). |
| 189. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authorization |
| Slicing | This element introduces a set of slices on ClinicalDocument.authorization. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 190. ClinicalDocument.authorization:authorization1 | |
| SliceName | authorization1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authorization |
| Requirements | MAY contain zero or more [0..*] authorization (CONF:1198-16792) such that it |
| 191. ClinicalDocument.authorization:authorization1.consent | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Consent |
| Requirements | SHALL contain exactly one [1..1] consent (CONF:1198-16793). |
| 192. ClinicalDocument.authorization:authorization1.consent.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | CONS |
| Fixed Value | CONS |
| 193. ClinicalDocument.authorization:authorization1.consent.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 194. ClinicalDocument.authorization:authorization1.consent.statusCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | This consent SHALL contain exactly one [1..1] statusCode (CONF:1198-16797). |
| 195. ClinicalDocument.authorization:authorization1.consent.statusCode.code | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-16798). |
| Default Value | completed |
| Fixed Value | completed |
| 196. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Component2 |
Guidance on how to interpret the contents of this table can be found here.
| 1. ClinicalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| 2. ClinicalDocument.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass; other codes may be used where these codes are not suitable |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | DOCCLIN |
| Fixed Value | DOCCLIN |
| 3. ClinicalDocument.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 4. ClinicalDocument.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] realmCode="US" (CONF:1198-16791). |
| Pattern Value | US |
| 5. ClinicalDocument.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] typeId (CONF:1198-5361). |
| 6. ClinicalDocument.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 7. ClinicalDocument.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 8. ClinicalDocument.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 9. ClinicalDocument.typeId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:1198-5250). |
| Pattern Value | 2.16.840.1.113883.1.3 |
| 10. ClinicalDocument.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:1198-5251). |
| Pattern Value | POCD_HD000040 |
| 11. ClinicalDocument.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ClinicalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 12. ClinicalDocument.templateId:primary | |
| SliceName | primary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1198-5252) such that it |
| 13. ClinicalDocument.templateId:primary.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 14. ClinicalDocument.templateId:primary.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 15. ClinicalDocument.templateId:primary.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 16. ClinicalDocument.templateId:primary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:1198-10036). |
| Pattern Value | 2.16.840.1.113883.10.20.22.1.1 |
| 17. ClinicalDocument.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32503). |
| Pattern Value | 2015-08-01 |
| 18. ClinicalDocument.templateId:secondary | |
| SliceName | secondary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1198-28458) such that it |
| Invariants | Defined on this element 1198-32945: When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32945). (: ) |
| 19. ClinicalDocument.templateId:secondary.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 20. ClinicalDocument.templateId:secondary.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 21. ClinicalDocument.templateId:secondary.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 22. ClinicalDocument.templateId:secondary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.29.1" (CONF:1198-28459). |
| Pattern Value | 2.16.840.1.113883.10.20.29.1 |
| 23. ClinicalDocument.templateId:secondary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32917). |
| Pattern Value | 2015-08-01 |
| 24. ClinicalDocument.id | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] id (CONF:1198-5363). |
| Invariants | Defined on this element 1198-9991: This id **SHALL** be a globally unique identifier for the document (CONF:1198-9991). (: ) |
| 25. ClinicalDocument.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1198-5253). |
| Invariants | Defined on this element 1198-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:1198-9992). (: ) 1198-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:1198-32948). (: ) |
| 26. ClinicalDocument.title | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
| Requirements | SHALL contain exactly one [1..1] title (CONF:1198-5254). |
| 27. ClinicalDocument.effectiveTime | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5256). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: ) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: ) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: ) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 28. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:1198-5259). |
| 29. ClinicalDocument.languageCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5372). |
| 30. ClinicalDocument.setId | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | MAY contain zero or one [0..1] setId (CONF:1198-5261). |
| Invariants | Defined on this element 1198-6380: If setId is present versionNumber **SHALL** be present (CONF:1198-6380). (: ) |
| 31. ClinicalDocument.versionNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| Requirements | MAY contain zero or one [0..1] versionNumber (CONF:1198-5264). |
| Invariants | Defined on this element 1198-6387: If versionNumber is present setId **SHALL** be present (CONF:1198-6387). (: ) |
| 32. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 33. ClinicalDocument.recordTarget | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RecordTarget |
| Requirements | SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460). |
| 34. ClinicalDocument.recordTarget.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 35. ClinicalDocument.recordTarget.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | RCT |
| 36. ClinicalDocument.recordTarget.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 37. ClinicalDocument.recordTarget.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 38. ClinicalDocument.recordTarget.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 39. ClinicalDocument.recordTarget.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 40. ClinicalDocument.recordTarget.patientRole | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PatientRole |
| Requirements | This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461). |
| 41. ClinicalDocument.recordTarget.patientRole.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassRelationshipFormal |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PAT |
| Fixed Value | PAT |
| 42. ClinicalDocument.recordTarget.patientRole.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 43. ClinicalDocument.recordTarget.patientRole.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462). |
| 44. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 45. ClinicalDocument.recordTarget.patientRole.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5271). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 46. ClinicalDocument.recordTarget.patientRole.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This patientRole SHALL contain at least one [1..*] telecom (CONF:1198-5280). |
| 47. ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 48. ClinicalDocument.recordTarget.patientRole.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 49. ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 50. ClinicalDocument.recordTarget.patientRole.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-5375). |
| 51. ClinicalDocument.recordTarget.patientRole.patient | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Patient |
| Requirements | This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465). |
| 52. ClinicalDocument.recordTarget.patientRole.patient.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 53. ClinicalDocument.recordTarget.patientRole.patient.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 54. ClinicalDocument.recordTarget.patientRole.patient.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 55. ClinicalDocument.recordTarget.patientRole.patient.id | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 56. ClinicalDocument.recordTarget.patientRole.patient.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPatientNamePTNUSFIELDED) |
| Requirements | This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:1198-5284). |
| Invariants | Defined on this element 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 57. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name desc. |
| 58. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Administrative Gender (HL7 V3) |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-6394). |
| 59. ClinicalDocument.recordTarget.patientRole.patient.birthTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This patient SHALL contain exactly one [1..1] birthTime (CONF:1198-5298). |
| Invariants | Defined on this element 1198-5299: **SHALL** be precise to year (CONF:1198-5299). (: ) 1198-5300: **SHOULD** be precise to day (CONF:1198-5300). (: ) 1198-32418: **MAY** be precise to the minute (CONF:1198-32418). For cases where information about newborn's time of birth needs to be captured. (: ) |
| 60. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedInd. |
| 61. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedTime. |
| 62. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthInd. |
| 63. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT-POS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthOrderNumber. |
| 64. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Marital Status |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:1198-5303). |
| 65. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Religious Affiliation |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:1198-5317). |
| 66. ClinicalDocument.recordTarget.patientRole.patient.raceCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Race Category Excluding Nulls |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:1198-5322). |
| 67. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Race Value Set; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name raceCode. |
| Requirements | This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race Value Set urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:1198-7263). |
| Invariants | Defined on this element 1198-31347: If sdtc:raceCode is present, then the patient SHALL contain [1..1] raceCode (CONF:1198-31347). (: ) |
| 68. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Ethnicity |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:1198-5323). |
| 69. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Detailed Ethnicity; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name ethnicGroupCode. |
| Requirements | This patient MAY contain zero or more [0..*] sdtc:ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:1198-32901). |
| 70. ClinicalDocument.recordTarget.patientRole.patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Guardian |
| Requirements | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469). |
| 71. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAgent |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | GUARD |
| Fixed Value | GUARD |
| 72. ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 73. ClinicalDocument.recordTarget.patientRole.patient.guardian.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470). |
| 74. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 75. ClinicalDocument.recordTarget.patientRole.patient.guardian.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28473). |
| 76. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5359). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 77. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:1198-5382). |
| 78. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 79. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 80. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 81. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7993). |
| 82. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:1198-5385). |
| 83. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 84. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 85. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 86. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
| Requirements | This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5386). |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 87. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 88. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 89. ClinicalDocument.recordTarget.patientRole.patient.birthplace | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Birthplace |
| Requirements | This patient MAY contain zero or one [0..1] birthplace (CONF:1198-5395). |
| 90. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassPassive |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | BIRTHPL |
| Fixed Value | BIRTHPL |
| 91. ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 92. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Place |
| Requirements | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:1198-5396). |
| 93. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassPlace |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PLC |
| Fixed Value | PLC |
| 94. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 95. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 96. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EN |
| 97. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| Requirements | This place SHALL contain exactly one [1..1] addr (CONF:1198-5397). |
| Invariants | Defined on this element 1198-5402: If 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:1198-5402). Note: A nullFlavor of ' UNK' may be used if the state is unknown. (: ) 1198-5403: If 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:1198-5403). (: ) |
| 98. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 99. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered | |
| Definition | A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information. |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 100. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use | |
| Definition | A set of codes advising a system or user which address in a set of like addresses to select for a given purpose. |
| Control | 0..* |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 101. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter | |
| Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 102. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 103. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 104. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 105. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 106. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 107. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 108. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 109. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 110. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 111. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 112. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 113. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 114. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DEL |
| 115. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country | |
| Definition | Country |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Requirements | This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:1198-5404). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 116. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 117. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 118. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 119. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 120. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 121. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 122. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 123. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 124. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 125. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 126. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 127. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 128. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | CNT |
| 129. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state | |
| Definition | A sub-unit of a country with limited sovereignty in a federally organized country. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 130. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 131. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 132. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 133. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 134. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 135. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 136. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 137. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 138. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 139. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 140. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 141. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 142. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | STA |
| 143. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county | |
| Definition | A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".) |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 144. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 145. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 146. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 147. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 148. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 149. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 150. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 151. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 152. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 153. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 154. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 155. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 156. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | CPA |
| 157. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city | |
| Definition | The name of the city, town, village, or other community or delivery center |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 158. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 159. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 160. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 161. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 162. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 163. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 164. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 165. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 166. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 167. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 168. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 169. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 170. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | CTY |
| 171. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode | |
| Definition | A postal code designating a region defined by the postal service. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 172. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 173. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 174. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 175. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 176. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 177. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 178. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 179. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 180. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 181. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 182. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 183. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 184. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | ZIP |
| 185. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine | |
| Definition | Street address line |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 186. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 187. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 188. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 189. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 190. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 191. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 192. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 193. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 194. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 195. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 196. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 197. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 198. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | SAL |
| 199. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber | |
| Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 200. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 201. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 202. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 203. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 204. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 205. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 206. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 207. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 208. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 209. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 210. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 211. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 212. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | BNR |
| 213. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric | |
| Definition | The numeric portion of a building number |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 214. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 215. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 216. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 217. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 218. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 219. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 220. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 221. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 222. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 223. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 224. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 225. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 226. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | BNN |
| 227. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction | |
| Definition | Direction (e.g., N, S, W, E) |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 228. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 229. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 230. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 231. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 232. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 233. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 234. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 235. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 236. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 237. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 238. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 239. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 240. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DIR |
| 241. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName | |
| Definition | Name of a roadway or artery recognized by a municipality (including street type and direction) |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 242. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 243. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 244. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 245. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 246. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 247. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 248. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 249. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 250. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 251. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 252. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 253. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 254. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | STR |
| 255. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase | |
| Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction) |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 256. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 257. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 258. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 259. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 260. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 261. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 262. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 263. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 264. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 265. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 266. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 267. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 268. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | STB |
| 269. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType | |
| Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.) |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 270. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 271. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 272. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 273. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 274. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 275. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 276. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 277. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 278. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 279. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 280. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 281. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 282. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | STTYP |
| 283. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator | |
| Definition | This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 284. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 285. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 286. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 287. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 288. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 289. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 290. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 291. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 292. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 293. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 294. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 295. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 296. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | ADL |
| 297. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID | |
| Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 298. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 299. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 300. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 301. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 302. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 303. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 304. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 305. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 306. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 307. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 308. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 309. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 310. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | UNID |
| 311. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType | |
| Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 312. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 313. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 314. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 315. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 316. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 317. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 318. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 319. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 320. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 321. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 322. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 323. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 324. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | UNIT |
| 325. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf | |
| Definition | The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 326. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 327. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 328. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 329. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 330. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 331. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 332. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 333. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 334. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 335. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 336. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 337. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 338. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | CAR |
| 339. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract | |
| Definition | A geographic sub-unit delineated for demographic purposes. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 340. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 341. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 342. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 343. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 344. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 345. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 346. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 347. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 348. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 349. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 350. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 351. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 352. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | CEN |
| 353. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine | |
| Definition | A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 354. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 355. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 356. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 357. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 358. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 359. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 360. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 361. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 362. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 363. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 364. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 365. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 366. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DAL |
| 367. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType | |
| Definition | Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 368. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 369. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 370. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 371. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 372. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 373. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 374. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 375. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 376. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 377. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 378. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 379. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 380. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DINST |
| 381. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea | |
| Definition | The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 382. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 383. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 384. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 385. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 386. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 387. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 388. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 389. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 390. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 391. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 392. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 393. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 394. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DINSTA |
| 395. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier | |
| Definition | A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 396. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 397. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 398. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 399. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 400. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 401. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 402. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 403. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 404. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 405. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 406. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 407. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 408. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DINSTQ |
| 409. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode | |
| Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 410. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 411. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 412. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 413. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 414. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 415. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 416. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 417. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 418. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 419. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 420. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 421. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 422. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DMOD |
| 423. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier | |
| Definition | Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number). |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 424. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 425. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 426. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 427. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 428. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 429. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 430. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 431. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 432. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 433. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 434. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 435. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 436. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DMODID |
| 437. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix | |
| Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 438. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 439. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 440. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 441. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 442. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 443. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 444. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 445. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 446. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 447. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 448. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 449. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 450. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | BNS |
| 451. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox | |
| Definition | A numbered box located in a post station. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 452. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 453. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 454. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 455. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 456. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 457. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 458. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 459. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 460. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 461. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 462. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 463. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 464. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | POB |
| 465. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct | |
| Definition | A subsection of a municipality |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ADXP |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 466. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 467. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.charset | |
| Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 468. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.compression | |
| Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CompressionAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 469. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.integrityCheck | |
| Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
| Control | 0..0 |
| Type | base64Binary |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 470. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.integrityCheckAlgorithm | |
| Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 471. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.language | |
| Definition | For character based information the language property specifies the human language of the text. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 472. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.mediaType | |
| Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | text/plain |
| 473. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.representation | |
| Definition | Specifies the representation of the binary data that is the content of the binary data value |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | TXT |
| 474. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.data[x] | |
| Definition | The string value |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 475. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.reference | |
| Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 476. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.thumbnail | |
| Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 477. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 478. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType | |
| Definition | Specifies the type of the address part |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | PRE |
| 479. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other | |
| Definition | Textual representation of (part of) the address |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as unadorned text. |
| 480. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod[x] | |
| Definition | A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 481. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication |
| Requirements | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-28474). |
| 482. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 483. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5407). |
| 484. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from LanguageAbilityMode |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:1198-5409). |
| 485. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from LanguageAbilityProficiency |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:1198-9965). |
| 486. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| Requirements | The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:1198-28475). |
| 487. ClinicalDocument.recordTarget.patientRole.providerOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| Requirements | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476). |
| 488. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ORG |
| Fixed Value | ORG |
| 489. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 490. ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 491. ClinicalDocument.recordTarget.patientRole.providerOrganization.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:1198-5417). |
| 492. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 493. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 494. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 495. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16820). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 496. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 497. ClinicalDocument.recordTarget.patientRole.providerOrganization.name | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ON |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:1198-5419). |
| 498. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:1198-5420). |
| 499. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 500. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 501. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 502. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7994). |
| 503. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5422). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 504. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from OrganizationIndustryClassNAICS; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 505. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf |
| 506. ClinicalDocument.author | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| Requirements | SHALL contain at least one [1..*] author (CONF:1198-28477). |
| 507. ClinicalDocument.author.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 508. ClinicalDocument.author.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | AUT |
| 509. ClinicalDocument.author.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 510. ClinicalDocument.author.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 511. ClinicalDocument.author.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 512. ClinicalDocument.author.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 513. ClinicalDocument.author.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 514. ClinicalDocument.author.time | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5445). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: ) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: ) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: ) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 515. ClinicalDocument.author.assignedAuthor | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor |
| Requirements | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478). |
| Invariants | Defined on this element 1198-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:1198-16790). (: ) |
| 516. ClinicalDocument.author.assignedAuthor.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 517. ClinicalDocument.author.assignedAuthor.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 518. ClinicalDocument.author.assignedAuthor.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479). |
| Invariants | Defined on this element 1198-5449: If this assignedAuthor is not an assignedPerson, this assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-5449). (: ) |
| Slicing | This element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 519. ClinicalDocument.author.assignedAuthor.id:id1 | |
| SliceName | id1 |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:1198-32882) such that it |
| 520. ClinicalDocument.author.assignedAuthor.id:id1.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:1198-32883). |
| Pattern Value | UNK |
| 521. ClinicalDocument.author.assignedAuthor.id:id1.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 522. ClinicalDocument.author.assignedAuthor.id:id1.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 523. ClinicalDocument.author.assignedAuthor.id:id1.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32884). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 524. ClinicalDocument.author.assignedAuthor.id:id1.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHOULD contain zero or one [0..1] @extension (CONF:1198-32885). |
| 525. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 526. ClinicalDocument.author.assignedAuthor.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-28481). |
| 527. ClinicalDocument.author.assignedAuthor.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 528. ClinicalDocument.author.assignedAuthor.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28676). |
| 529. ClinicalDocument.author.assignedAuthor.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 530. ClinicalDocument.author.assignedAuthor.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 531. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 532. ClinicalDocument.author.assignedAuthor.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 533. ClinicalDocument.author.assignedAuthor.code.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 534. ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 535. ClinicalDocument.author.assignedAuthor.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 536. ClinicalDocument.author.assignedAuthor.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 537. ClinicalDocument.author.assignedAuthor.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 538. ClinicalDocument.author.assignedAuthor.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5452). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 539. ClinicalDocument.author.assignedAuthor.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:1198-5428). |
| 540. ClinicalDocument.author.assignedAuthor.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 541. ClinicalDocument.author.assignedAuthor.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 542. ClinicalDocument.author.assignedAuthor.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 543. ClinicalDocument.author.assignedAuthor.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7995). |
| 544. ClinicalDocument.author.assignedAuthor.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:1198-5430). |
| 545. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 546. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 547. ClinicalDocument.author.assignedAuthor.assignedPerson.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 548. ClinicalDocument.author.assignedAuthor.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
| Requirements | The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-16789). |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 549. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 550. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AuthoringDevice |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:1198-16783). |
| 551. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassDevice |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | DEV |
| Fixed Value | DEV |
| 552. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 553. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 554. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 555. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SC |
| Requirements | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:1198-16784). |
| 556. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SC |
| Requirements | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:1198-16785). |
| 557. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/MaintainedEntity |
| 558. ClinicalDocument.author.assignedAuthor.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 559. ClinicalDocument.dataEnterer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DataEnterer |
| Requirements | MAY contain zero or one [0..1] dataEnterer (CONF:1198-28678). |
| 560. ClinicalDocument.dataEnterer.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 561. ClinicalDocument.dataEnterer.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | ENT |
| 562. ClinicalDocument.dataEnterer.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 563. ClinicalDocument.dataEnterer.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 564. ClinicalDocument.dataEnterer.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 565. ClinicalDocument.dataEnterer.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 566. ClinicalDocument.dataEnterer.time | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 567. ClinicalDocument.dataEnterer.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679). |
| 568. ClinicalDocument.dataEnterer.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 569. ClinicalDocument.dataEnterer.assignedEntity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 570. ClinicalDocument.dataEnterer.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5443). |
| 571. ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 572. ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 573. ClinicalDocument.dataEnterer.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 574. ClinicalDocument.dataEnterer.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16821). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 575. ClinicalDocument.dataEnterer.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 576. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 577. ClinicalDocument.dataEnterer.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680). |
| 578. ClinicalDocument.dataEnterer.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5460). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 579. ClinicalDocument.dataEnterer.assignedEntity.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5466). |
| 580. ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 581. ClinicalDocument.dataEnterer.assignedEntity.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 582. ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 583. ClinicalDocument.dataEnterer.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7996). |
| 584. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-5469). |
| 585. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 586. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 587. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 588. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5470). |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 589. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 590. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 591. ClinicalDocument.informant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| Slicing | This element introduces a set of slices on ClinicalDocument.informant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 592. ClinicalDocument.informant:informant1 | |
| SliceName | informant1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| Requirements | MAY contain zero or more [0..*] informant (CONF:1198-28681) such that it |
| 593. ClinicalDocument.informant:informant1.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 594. ClinicalDocument.informant:informant1.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | INF |
| 595. ClinicalDocument.informant:informant1.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 596. ClinicalDocument.informant:informant1.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 597. ClinicalDocument.informant:informant1.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 598. ClinicalDocument.informant:informant1.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 599. ClinicalDocument.informant:informant1.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8002). |
| 600. ClinicalDocument.informant:informant1.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 601. ClinicalDocument.informant:informant1.assignedEntity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 602. ClinicalDocument.informant:informant1.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-9945). |
| Invariants | Defined on this element 1198-9946: If 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:1198-9946). (: ) |
| 603. ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 604. ClinicalDocument.informant:informant1.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-32174). |
| 605. ClinicalDocument.informant:informant1.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-8220). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 606. ClinicalDocument.informant:informant1.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 607. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-8221). |
| 608. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 609. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 610. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 611. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-8222). |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 612. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 613. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 614. ClinicalDocument.informant:informant1.relatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| Requirements | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682). |
| 615. ClinicalDocument.informant:informant1.relatedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassMutualRelationship |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 616. ClinicalDocument.informant:informant1.relatedEntity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 617. ClinicalDocument.informant:informant1.relatedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from PersonalRelationshipRoleType; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683). |
| 618. ClinicalDocument.informant:informant1.relatedEntity.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 619. ClinicalDocument.informant:informant1.relatedEntity.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The code, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28684). |
| 620. ClinicalDocument.informant:informant1.relatedEntity.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 621. ClinicalDocument.informant:informant1.relatedEntity.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 622. ClinicalDocument.informant:informant1.relatedEntity.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 623. ClinicalDocument.informant:informant1.relatedEntity.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 624. ClinicalDocument.informant:informant1.relatedEntity.code.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 625. ClinicalDocument.informant:informant1.relatedEntity.code.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 626. ClinicalDocument.informant:informant1.relatedEntity.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 627. ClinicalDocument.informant:informant1.relatedEntity.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 628. ClinicalDocument.informant:informant1.relatedEntity.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 629. ClinicalDocument.informant:informant1.relatedEntity.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| 630. ClinicalDocument.informant:informant1.relatedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 631. ClinicalDocument.informant:informant1.relatedEntity.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 632. ClinicalDocument.informant:informant1.relatedEntity.relatedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| 633. ClinicalDocument.informant:informant2 | |
| SliceName | informant2 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Informant |
| Requirements | MAY contain zero or more [0..*] informant (CONF:1198-31355) such that it |
| 634. ClinicalDocument.informant:informant2.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 635. ClinicalDocument.informant:informant2.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | INF |
| 636. ClinicalDocument.informant:informant2.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 637. ClinicalDocument.informant:informant2.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 638. ClinicalDocument.informant:informant2.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 639. ClinicalDocument.informant:informant2.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 640. ClinicalDocument.informant:informant2.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 641. ClinicalDocument.informant:informant2.relatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| Requirements | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-31356). |
| 642. ClinicalDocument.custodian | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Custodian |
| Requirements | SHALL contain exactly one [1..1] custodian (CONF:1198-28685). |
| 643. ClinicalDocument.custodian.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 644. ClinicalDocument.custodian.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | ENT |
| 645. ClinicalDocument.custodian.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 646. ClinicalDocument.custodian.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 647. ClinicalDocument.custodian.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 648. ClinicalDocument.custodian.assignedCustodian | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedCustodian |
| Requirements | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686). |
| 649. ClinicalDocument.custodian.assignedCustodian.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 650. ClinicalDocument.custodian.assignedCustodian.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 651. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CustodianOrganization |
| Requirements | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-28687). |
| 652. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ORG |
| Fixed Value | ORG |
| 653. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 654. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 655. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-28688). |
| 656. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 657. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 658. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 659. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16822). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 660. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 661. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ON |
| Requirements | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:1198-5524). |
| 662. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:1198-5525). |
| 663. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 664. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 665. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 666. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7998). |
| 667. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5559). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 668. ClinicalDocument.informationRecipient | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient |
| Requirements | MAY contain zero or more [0..*] informationRecipient (CONF:1198-28690). |
| 669. ClinicalDocument.informationRecipient.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 670. ClinicalDocument.informationRecipient.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PRCP |
| 671. ClinicalDocument.informationRecipient.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 672. ClinicalDocument.informationRecipient.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 673. ClinicalDocument.informationRecipient.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 674. ClinicalDocument.informationRecipient.intendedRecipient | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IntendedRecipient |
| Requirements | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691). |
| 675. ClinicalDocument.informationRecipient.intendedRecipient.classCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| 676. ClinicalDocument.informationRecipient.intendedRecipient.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 677. ClinicalDocument.informationRecipient.intendedRecipient.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This intendedRecipient SHOULD contain zero or more [0..*] id (CONF:1198-28692). |
| 678. ClinicalDocument.informationRecipient.intendedRecipient.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 679. ClinicalDocument.informationRecipient.intendedRecipient.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 680. ClinicalDocument.informationRecipient.intendedRecipient.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 681. ClinicalDocument.informationRecipient.intendedRecipient.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693). |
| 682. ClinicalDocument.informationRecipient.intendedRecipient.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 683. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 684. ClinicalDocument.informationRecipient.intendedRecipient.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| 685. ClinicalDocument.informationRecipient.intendedRecipient.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 686. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:1198-5567). |
| 687. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 688. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 689. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 690. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
| Requirements | The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5568). |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 691. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 692. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| Requirements | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:1198-5577). |
| 693. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ORG |
| Fixed Value | ORG |
| 694. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 695. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 696. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 697. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ON |
| Requirements | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:1198-5578). |
| 698. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 699. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| 700. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from OrganizationIndustryClassNAICS; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 701. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf |
| 702. ClinicalDocument.legalAuthenticator | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator |
| Requirements | MAY contain zero or one [0..1] legalAuthenticator (CONF:1198-28694). |
| 703. ClinicalDocument.legalAuthenticator.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 704. ClinicalDocument.legalAuthenticator.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | LA |
| 705. ClinicalDocument.legalAuthenticator.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 706. ClinicalDocument.legalAuthenticator.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 707. ClinicalDocument.legalAuthenticator.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 708. ClinicalDocument.legalAuthenticator.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 709. ClinicalDocument.legalAuthenticator.time | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5580). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: ) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: ) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: ) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 710. ClinicalDocument.legalAuthenticator.signatureCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:1198-5583). |
| 711. ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 712. ClinicalDocument.legalAuthenticator.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5584). |
| Pattern Value | S |
| 713. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 714. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 715. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 716. ClinicalDocument.legalAuthenticator.signatureCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 717. ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 718. ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 719. ClinicalDocument.legalAuthenticator.signatureCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 720. ClinicalDocument.legalAuthenticator.signatureCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 721. ClinicalDocument.legalAuthenticator.signatureCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 722. ClinicalDocument.legalAuthenticator.sdtcSignatureText | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name signatureText. |
| 723. ClinicalDocument.legalAuthenticator.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695). |
| 724. ClinicalDocument.legalAuthenticator.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 725. ClinicalDocument.legalAuthenticator.assignedEntity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 726. ClinicalDocument.legalAuthenticator.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28696). |
| 727. ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 728. ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 729. ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 730. ClinicalDocument.legalAuthenticator.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16823). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 731. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 732. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 733. ClinicalDocument.legalAuthenticator.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697). |
| 734. ClinicalDocument.legalAuthenticator.assignedEntity.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 735. ClinicalDocument.legalAuthenticator.assignedEntity.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28698). |
| 736. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 737. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 738. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 739. ClinicalDocument.legalAuthenticator.assignedEntity.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 740. ClinicalDocument.legalAuthenticator.assignedEntity.code.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 741. ClinicalDocument.legalAuthenticator.assignedEntity.code.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 742. ClinicalDocument.legalAuthenticator.assignedEntity.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 743. ClinicalDocument.legalAuthenticator.assignedEntity.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 744. ClinicalDocument.legalAuthenticator.assignedEntity.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 745. ClinicalDocument.legalAuthenticator.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5589). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 746. ClinicalDocument.legalAuthenticator.assignedEntity.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5595). |
| 747. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 748. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 749. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 750. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7999). |
| 751. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-5597). |
| 752. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 753. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 754. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 755. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5598). |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 756. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 757. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 758. ClinicalDocument.authenticator | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authenticator |
| Requirements | MAY contain zero or more [0..*] authenticator (CONF:1198-28699). |
| Slicing | This element introduces a set of slices on ClinicalDocument.authenticator. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 759. ClinicalDocument.authenticator.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 760. ClinicalDocument.authenticator.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | AUTHEN |
| 761. ClinicalDocument.authenticator.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 762. ClinicalDocument.authenticator.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 763. ClinicalDocument.authenticator.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 764. ClinicalDocument.authenticator.time | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 765. ClinicalDocument.authenticator.signatureCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 766. ClinicalDocument.authenticator.sdtcSignatureText | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name signatureText. |
| 767. ClinicalDocument.authenticator.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700). |
| 768. ClinicalDocument.authenticator.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 769. ClinicalDocument.authenticator.assignedEntity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 770. ClinicalDocument.authenticator.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701). |
| 771. ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 772. ClinicalDocument.authenticator.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702). |
| 773. ClinicalDocument.authenticator.assignedEntity.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| 774. ClinicalDocument.authenticator.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 775. ClinicalDocument.authenticator.assignedEntity.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| 776. ClinicalDocument.authenticator.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 777. ClinicalDocument.authenticator:authenticator1 | |
| SliceName | authenticator1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authenticator |
| Requirements | MAY contain zero or more [0..*] authenticator (CONF:1198-5607) such that it |
| 778. ClinicalDocument.authenticator:authenticator1.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 779. ClinicalDocument.authenticator:authenticator1.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | AUTHEN |
| 780. ClinicalDocument.authenticator:authenticator1.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 781. ClinicalDocument.authenticator:authenticator1.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 782. ClinicalDocument.authenticator:authenticator1.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 783. ClinicalDocument.authenticator:authenticator1.time | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED) |
| Requirements | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5608). |
| Invariants | Defined on this element 81-10127: **SHALL** be precise to the day (CONF:81-10127). (: ) 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: ) 81-10129: **MAY** be precise to the second (CONF:81-10129). (: ) 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 784. ClinicalDocument.authenticator:authenticator1.signatureCode | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] signatureCode (CONF:1198-5610). |
| 785. ClinicalDocument.authenticator:authenticator1.signatureCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 786. ClinicalDocument.authenticator:authenticator1.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5611). |
| Pattern Value | S |
| 787. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 788. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 789. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 790. ClinicalDocument.authenticator:authenticator1.signatureCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 791. ClinicalDocument.authenticator:authenticator1.signatureCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 792. ClinicalDocument.authenticator:authenticator1.signatureCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 793. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 794. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 795. ClinicalDocument.authenticator:authenticator1.signatureCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 796. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name signatureText. |
| 797. ClinicalDocument.authenticator:authenticator1.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1198-5612). |
| 798. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 799. ClinicalDocument.authenticator:authenticator1.assignedEntity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 800. ClinicalDocument.authenticator:authenticator1.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5613). |
| 801. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 802. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 803. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 804. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16824). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 805. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 806. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 807. ClinicalDocument.authenticator:authenticator1.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-16825). |
| 808. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 809. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-16826). |
| 810. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 811. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 812. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 813. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 814. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 815. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 816. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 817. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 818. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 819. ClinicalDocument.authenticator:authenticator1.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED) |
| Requirements | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5616). |
| Invariants | Defined on this element 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 820. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5622). |
| 821. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 822. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value | |
| Control | 0..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 823. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 824. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-8000). |
| 825. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-5624). |
| 826. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 827. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 828. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 829. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name | |
| Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
| Requirements | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-5625). |
| Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 830. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 831. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 832. ClinicalDocument.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant1 |
| Requirements | MAY contain zero or more [0..*] participant (CONF:1198-28703). |
| Slicing | This element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and defines no discriminators to differentiate the slices |
| 833. ClinicalDocument.participant:participant1 | |
| SliceName | participant1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant1 |
| Requirements | MAY contain zero or more [0..*] participant (CONF:1198-10003) such that it |
| Invariants | Defined on this element 1198-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:1198-10006). (: ) 1198-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *STATIC 2011-09-30* (CONF:1198-10007). (: ) |
| 834. ClinicalDocument.participant:participant1.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 835. ClinicalDocument.participant:participant1.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 836. ClinicalDocument.participant:participant1.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 837. ClinicalDocument.participant:participant1.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 838. ClinicalDocument.participant:participant1.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 839. ClinicalDocument.participant:participant1.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 840. ClinicalDocument.participant:participant1.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 841. ClinicalDocument.participant:participant1.time | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Requirements | MAY contain zero or one [0..1] time (CONF:1198-10004). |
| 842. ClinicalDocument.participant:participant1.associatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity |
| 843. ClinicalDocument.inFulfillmentOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf |
| Requirements | MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707). |
| 844. ClinicalDocument.inFulfillmentOf.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 845. ClinicalDocument.inFulfillmentOf.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | FLFS |
| 846. ClinicalDocument.inFulfillmentOf.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 847. ClinicalDocument.inFulfillmentOf.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 848. ClinicalDocument.inFulfillmentOf.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 849. ClinicalDocument.inFulfillmentOf.order | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Order |
| Requirements | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708). |
| 850. ClinicalDocument.inFulfillmentOf.order.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ACT |
| 851. ClinicalDocument.inFulfillmentOf.order.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMoodIntent |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | RQO |
| Fixed Value | RQO |
| 852. ClinicalDocument.inFulfillmentOf.order.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 853. ClinicalDocument.inFulfillmentOf.order.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This order SHALL contain at least one [1..*] id (CONF:1198-28709). |
| 854. ClinicalDocument.inFulfillmentOf.order.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 855. ClinicalDocument.inFulfillmentOf.order.priorityCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 856. ClinicalDocument.documentationOf | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/DocumentationOf |
| Requirements | MAY contain zero or more [0..*] documentationOf (CONF:1198-28710). |
| 857. ClinicalDocument.documentationOf.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 858. ClinicalDocument.documentationOf.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | DOC |
| 859. ClinicalDocument.documentationOf.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 860. ClinicalDocument.documentationOf.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 861. ClinicalDocument.documentationOf.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 862. ClinicalDocument.documentationOf.serviceEvent | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ServiceEvent |
| Requirements | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711). |
| 863. ClinicalDocument.documentationOf.serviceEvent.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ACT |
| 864. ClinicalDocument.documentationOf.serviceEvent.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 865. ClinicalDocument.documentationOf.serviceEvent.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 866. ClinicalDocument.documentationOf.serviceEvent.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 867. ClinicalDocument.documentationOf.serviceEvent.code | |
| Definition | Drawn from concept domain ActCode |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712). |
| 868. ClinicalDocument.documentationOf.serviceEvent.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Requirements | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-14837). |
| 869. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 870. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 871. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.inclusive | |
| Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 872. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 873. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-14838). |
| 874. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 875. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width | |
| Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| 876. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center | |
| Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 877. ClinicalDocument.documentationOf.serviceEvent.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer1 |
| Requirements | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713). |
| 878. ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 879. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ServiceEventPerformer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:1198-14840). |
| Fixed Value | DOC |
| 880. ClinicalDocument.documentationOf.serviceEvent.performer.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 881. ClinicalDocument.documentationOf.serviceEvent.performer.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 882. ClinicalDocument.documentationOf.serviceEvent.performer.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 883. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-28714). |
| 884. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 885. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Care Team Member Function |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32889). |
| 886. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 887. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 888. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 889. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 890. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 891. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 892. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 893. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 894. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 895. ClinicalDocument.documentationOf.serviceEvent.performer.time | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 896. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| Requirements | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715). |
| 897. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 898. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 899. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716). |
| 900. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 901. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 902. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 903. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-14847). |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 904. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 905. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 906. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718). |
| 907. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| 908. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 909. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| 910. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| 911. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedDocument |
| 912. ClinicalDocument.authorization | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authorization |
| Slicing | This element introduces a set of slices on ClinicalDocument.authorization. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 913. ClinicalDocument.authorization:authorization1 | |
| SliceName | authorization1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Authorization |
| Requirements | MAY contain zero or more [0..*] authorization (CONF:1198-16792) such that it |
| 914. ClinicalDocument.authorization:authorization1.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 915. ClinicalDocument.authorization:authorization1.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | AUT |
| 916. ClinicalDocument.authorization:authorization1.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 917. ClinicalDocument.authorization:authorization1.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 918. ClinicalDocument.authorization:authorization1.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 919. ClinicalDocument.authorization:authorization1.consent | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Consent |
| Requirements | SHALL contain exactly one [1..1] consent (CONF:1198-16793). |
| 920. ClinicalDocument.authorization:authorization1.consent.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | CONS |
| Fixed Value | CONS |
| 921. ClinicalDocument.authorization:authorization1.consent.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 922. ClinicalDocument.authorization:authorization1.consent.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 923. ClinicalDocument.authorization:authorization1.consent.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This consent MAY contain zero or more [0..*] id (CONF:1198-16794). |
| 924. ClinicalDocument.authorization:authorization1.consent.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This consent MAY contain zero or one [0..1] code (CONF:1198-16795). |
| 925. ClinicalDocument.authorization:authorization1.consent.statusCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | This consent SHALL contain exactly one [1..1] statusCode (CONF:1198-16797). |
| 926. ClinicalDocument.authorization:authorization1.consent.statusCode.code | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-16798). |
| Default Value | completed |
| Fixed Value | completed |
| 927. ClinicalDocument.componentOf | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ComponentOf |
| Requirements | MAY contain zero or one [0..1] componentOf (CONF:1198-9955). |
| 928. ClinicalDocument.componentOf.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 929. ClinicalDocument.componentOf.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | AUT |
| 930. ClinicalDocument.componentOf.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 931. ClinicalDocument.componentOf.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 932. ClinicalDocument.componentOf.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 933. ClinicalDocument.componentOf.encompassingEncounter | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EncompassingEncounter |
| Requirements | The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-9956). |
| 934. ClinicalDocument.componentOf.encompassingEncounter.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ENC |
| Fixed Value | ENC |
| 935. ClinicalDocument.componentOf.encompassingEncounter.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | EVN |
| Fixed Value | EVN |
| 936. ClinicalDocument.componentOf.encompassingEncounter.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 937. ClinicalDocument.componentOf.encompassingEncounter.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:1198-9959). |
| 938. ClinicalDocument.componentOf.encompassingEncounter.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 939. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Requirements | This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:1198-9958). |
| 940. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name admissionReferralSourceCode. |
| 941. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from USEncounterDischargeDisposition; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 942. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 943. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 944. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 945. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | RESP |
| Fixed Value | RESP |
| 946. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 947. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant |
| 948. ClinicalDocument.componentOf.encompassingEncounter.location | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 949. ClinicalDocument.componentOf.encompassingEncounter.location.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 950. ClinicalDocument.componentOf.encompassingEncounter.location.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ClinicalDocument.componentOf.encompassingEncounter.location.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 951. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetLocation |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | LOC |
| Fixed Value | LOC |
| 952. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility |
| 953. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Component2 |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 generated with FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change