2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: PatientRole

The official URL for this profile is: 

http://hl7.org/fhir/Profile/cda-patient-role

. Standard Profile for CDA R2 on FHIR

This profile was published on Sun, Nov 16, 2014 00:00+1100 with unknown status 'preliminary" by .

unable to summarise extension (no extension found)

Formal Views of Profile Content

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

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1ResourceCDA PatientRole
... identifier 0..*IdentifierPatient Identifier
... name 0..*HumanNamePatient names
... telecom 0..*ContactPointPatient Contact Details
... gender 0..1codePatient administrative Gender
... birthDate 0..1datePatient Birthtime
... deceased[x] M0..0
... address 0..*AddressPatient Address
... maritalStatus 0..1CodeableConceptCDA Patient Marital Status
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..*CDA Guardian
.... relationship Slice: Ordered, Open At End, by coding.code
.... relationship 1..1in CDA, only Guardian is allowed
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/patient-contact-relationship","code":"guardian"}]}
.... relationship 0..1
.... name Guardian name (if a person)
.... telecom 0..*ContactPointA contact detail for the guardian
.... address 0..1Address for the guardian
.... gender 0..0
.... organization 0..1#OrganizationOrganization that acts as guardian for the contact
.... cda-guardian-id 0..*IdentifierCDA Guardian Identifier
... animal 0..0
... communication 0..*CodeableConceptCDA patient language
.... cda-language-mode 0..1CodeableConceptCDA patient language mode
.... cda-language-proficiency 0..1CodeableConceptCDA patient language proficiency
.... cda-language-preference 0..1booleanCDA patient language preference
... careProvider 0..0
... managingOrganization 0..1#OrganizationOrganization that is the custodian of the patient record
... link 0..0
... active 0..0
... us-core-religion 0..1CodeableConceptPatient's religious classification
... us-core-race 0..1CodeableConceptPatient's racial classification
... us-core-ethnicity 0..1CodeableConceptPatient's ethnic classification
... extension 0..1?? http://hl7.org/fhir/ExtensionDefinition/cda-BirthplacePatient's birthplace
URL: http://hl7.org/fhir/ExtensionDefinition/cda-Birthplace

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1ResourceCDA PatientRole
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race 0..1CodeableConceptPatient's racial classification
... us-core-ethnicity 0..1CodeableConceptPatient's ethnic classification
... extension 0..1?? http://hl7.org/fhir/ExtensionDefinition/cda-BirthplacePatient's birthplace
URL: http://hl7.org/fhir/ExtensionDefinition/cda-Birthplace
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierPatient Identifier
... name Σ0..*HumanNamePatient names
... telecom Σ0..*ContactPointPatient Contact Details
... gender Σ0..1codePatient administrative Gender
Binding: AdministrativeGender (required, not extensible)
... birthDate Σ0..1datePatient Birthtime
... birthTime Σ0..1timeThe time of birth for the individual
... address Σ0..*AddressPatient Address
... maritalStatus Σ0..1CodeableConceptCDA Patient Marital Status
Binding: MaritalStatus (preferred, extensible)
... contact I0..*CDA Guardian
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1idxml:id (or equivalent in JSON)
.... cda-guardian-id 0..*IdentifierCDA Guardian Identifier
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... relationship CodeableConceptThe kind of relationship
Slice: Ordered, Open At End, by coding.code
Binding: ContactRelationship (preferred, extensible)
.... relationship 1..1CodeableConceptin CDA, only Guardian is allowed
Binding: ContactRelationship (preferred, extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/patient-contact-relationship","code":"guardian"}]}
.... relationship 0..1CodeableConceptThe kind of relationship
Binding: ContactRelationship (preferred, extensible)
.... name 0..1HumanNameGuardian name (if a person)
.... telecom 0..*ContactPointA contact detail for the guardian
.... address 0..1AddressAddress for the guardian
.... organization I0..1#OrganizationOrganization that acts as guardian for the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... communication 0..*CodeableConceptCDA patient language
Binding: Language (required, not extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... cda-language-proficiency 0..1CodeableConceptCDA patient language proficiency
.... cda-language-preference 0..1booleanCDA patient language preference
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... managingOrganization Σ0..1#OrganizationOrganization that is the custodian of the patient record

XML Template

JSON Template

todo

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1ResourceCDA PatientRole
... identifier 0..*IdentifierPatient Identifier
... name 0..*HumanNamePatient names
... telecom 0..*ContactPointPatient Contact Details
... gender 0..1codePatient administrative Gender
... birthDate 0..1datePatient Birthtime
... deceased[x] M0..0
... address 0..*AddressPatient Address
... maritalStatus 0..1CodeableConceptCDA Patient Marital Status
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..*CDA Guardian
.... relationship Slice: Ordered, Open At End, by coding.code
.... relationship 1..1in CDA, only Guardian is allowed
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/patient-contact-relationship","code":"guardian"}]}
.... relationship 0..1
.... name Guardian name (if a person)
.... telecom 0..*ContactPointA contact detail for the guardian
.... address 0..1Address for the guardian
.... gender 0..0
.... organization 0..1#OrganizationOrganization that acts as guardian for the contact
.... cda-guardian-id 0..*IdentifierCDA Guardian Identifier
... animal 0..0
... communication 0..*CodeableConceptCDA patient language
.... cda-language-mode 0..1CodeableConceptCDA patient language mode
.... cda-language-proficiency 0..1CodeableConceptCDA patient language proficiency
.... cda-language-preference 0..1booleanCDA patient language preference
... careProvider 0..0
... managingOrganization 0..1#OrganizationOrganization that is the custodian of the patient record
... link 0..0
... active 0..0
... us-core-religion 0..1CodeableConceptPatient's religious classification
... us-core-race 0..1CodeableConceptPatient's racial classification
... us-core-ethnicity 0..1CodeableConceptPatient's ethnic classification
... extension 0..1?? http://hl7.org/fhir/ExtensionDefinition/cda-BirthplacePatient's birthplace
URL: http://hl7.org/fhir/ExtensionDefinition/cda-Birthplace

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1ResourceCDA PatientRole
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race 0..1CodeableConceptPatient's racial classification
... us-core-ethnicity 0..1CodeableConceptPatient's ethnic classification
... extension 0..1?? http://hl7.org/fhir/ExtensionDefinition/cda-BirthplacePatient's birthplace
URL: http://hl7.org/fhir/ExtensionDefinition/cda-Birthplace
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierPatient Identifier
... name Σ0..*HumanNamePatient names
... telecom Σ0..*ContactPointPatient Contact Details
... gender Σ0..1codePatient administrative Gender
Binding: AdministrativeGender (required, not extensible)
... birthDate Σ0..1datePatient Birthtime
... birthTime Σ0..1timeThe time of birth for the individual
... address Σ0..*AddressPatient Address
... maritalStatus Σ0..1CodeableConceptCDA Patient Marital Status
Binding: MaritalStatus (preferred, extensible)
... contact I0..*CDA Guardian
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1idxml:id (or equivalent in JSON)
.... cda-guardian-id 0..*IdentifierCDA Guardian Identifier
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... relationship CodeableConceptThe kind of relationship
Slice: Ordered, Open At End, by coding.code
Binding: ContactRelationship (preferred, extensible)
.... relationship 1..1CodeableConceptin CDA, only Guardian is allowed
Binding: ContactRelationship (preferred, extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/patient-contact-relationship","code":"guardian"}]}
.... relationship 0..1CodeableConceptThe kind of relationship
Binding: ContactRelationship (preferred, extensible)
.... name 0..1HumanNameGuardian name (if a person)
.... telecom 0..*ContactPointA contact detail for the guardian
.... address 0..1AddressAddress for the guardian
.... organization I0..1#OrganizationOrganization that acts as guardian for the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... communication 0..*CodeableConceptCDA patient language
Binding: Language (required, not extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... cda-language-proficiency 0..1CodeableConceptCDA patient language proficiency
.... cda-language-preference 0..1booleanCDA patient language preference
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... managingOrganization Σ0..1#OrganizationOrganization that is the custodian of the patient record

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Patient.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.maritalStatusMaritalStatuspreferred (extensible)Marital Status Codes
Patient.contact.relationshipContactRelationshippreferred (extensible)PatientContactRelationship
Patient.contact.relationshipContactRelationshippreferred (extensible)PatientContactRelationship
Patient.contact.relationshipContactRelationshippreferred (extensible)PatientContactRelationship
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexample (extensible)AnimalSpecies
Patient.animal.breedAnimalBreedexample (extensible)AnimalBreeds
Patient.animal.genderStatusAnimalGenderStatusexample (extensible)GenderStatus
Patient.communicationLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

Constraints

IdPathNameDetails
pat-1Patient.contactContactNeedsDetailsSHALL at least contain a contact's details or a reference to an organization
XPath: f:name or f:telecom or f:address or f:organization
.