DSTU2 Ballot Source

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

5.1.1.3 StructureDefinition: QICore-Patient

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/patient-qicore-qicore-patient

Profile of Patient for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile was published on Fri, Feb 27, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - CQI WG.

5.1.1.3.1 Formal Views of Profile Content

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

This structure is derived from Patient.

Summary

Mandatory: 3 elements, Must-Support: 5 elements, Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... telecom 0..*
.... iso21090-preferred 0..1booleanpreferred
... gender S
... birthDate S
.... iso21090-verification 0..1CodeableConceptverification
Binding: QICorePatientVerification (example)
... deceased[x] S
... address
.... state Binding: QICoreAddressState (preferred)
.... iso21090-preferred 0..1booleanpreferred
... maritalStatus Binding: QICoreMaritalStatus (preferred)
... contact
.... relationship CodeableConceptBinding: QICorePatientContactRelationship (extensible)
.... organization organization-qicore-qicore-organization
... animal 0..0
... communication
... careProvider organization-qicore-qicore-organization, practitioner-qicore-qicore-practitioner
... managingOrganization organization-qicore-qicore-organization
... link
.... other patient-qicore-qicore-patient
... active S
... us-core-race 0..1CodeableConceptA category of humans sharing history, origin or nationality
Binding: QICoreRace (preferred)
... us-core-ethnicity 0..1CodeableConceptA category of human sharing heritage
Binding: QICoreEthnicity (preferred)
... us-core-religion 0..1CodeableConceptPatient's professed religious affiliation
Binding: DAFReligion (extensible)
... birthPlace 0..1AddressPlace of Birth for patient
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
Binding: QICorePatientDisability (preferred)
... patient-importance 0..1CodeableConceptSpecial status given the patient
Binding: QICorePatientImportance (preferred)
... patient-nationality 0..*(Complex)Nationality
.... patient-nationality-code 1..1CodeableConceptNationality Code
Binding: USCountry (extensible)
.... patient-nationality-period 0..1PeriodNationality Period
... patient-citizenship 0..*(Complex)Nation(s) where the patient claims citizenship
.... patient-citizenship-code 1..1CodeableConceptNation code of citizenship
Binding: USCountry (extensible)
.... patient-citizenship-period 0..1PeriodTime period of citizenship
... patient-cadavericDonor 0..1booleanPost-mortem donor status
... patient-militaryService 0..1CodeableConceptIndicates the current or former military service of the patient
Binding: QICorePatientMilitaryService (example)
... patient-clinicalTrial 0..*(Complex)The patient's participation in clinical trials
.... patient-clinicalTrial-NCT 1..1stringNational Clinical Trial number
.... patient-clinicalTrial-period 0..1PeriodThe period of participation in the clinical trial
.... patient-clinicalTrial-reason 0..1CodeableConceptThe reason for participation in the clinical trial
Binding: QICoreProblemCode (preferred)
... patient-birthTime S0..1dateTimeTime of day of birth
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1PatientInformation about an individual or animal receiving health care services
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race 0..1CodeableConceptExtension
Binding: QICoreRace (preferred)
... us-core-ethnicity 0..1CodeableConceptExtension
Binding: QICoreEthnicity (preferred)
... us-core-religion 0..1CodeableConceptExtension
Binding: DAFReligion (extensible)
... birthPlace 0..1AddressExtension
... patient-disability 0..*CodeableConceptExtension
Binding: QICorePatientDisability (preferred)
... patient-importance 0..1CodeableConceptExtension
Binding: QICorePatientImportance (preferred)
... patient-nationality 0..*(Complex)Extension
.... patient-nationality-code 1..1CodeableConceptExtension
Binding: USCountry (extensible)
.... patient-nationality-period 0..1PeriodExtension
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-citizenship 0..*(Complex)Extension
.... patient-citizenship-code 1..1CodeableConceptExtension
Binding: USCountry (extensible)
.... patient-citizenship-period 0..1PeriodExtension
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-cadavericDonor 0..1booleanExtension
... patient-militaryService 0..1CodeableConceptExtension
Binding: QICorePatientMilitaryService (example)
... patient-clinicalTrial 0..*(Complex)Extension
.... patient-clinicalTrial-NCT 1..1stringExtension
.... patient-clinicalTrial-period 0..1PeriodExtension
.... patient-clinicalTrial-reason 0..1CodeableConceptExtension
Binding: QICoreProblemCode (preferred)
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-birthTime S0..1dateTimeExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAn identifier for this patient
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
.... iso21090-preferred 0..1booleanExtension
.... system I0..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value 0..1stringThe actual contact point details
.... use ?!0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period 0..1PeriodTime period when the contact point was/is in use
... gender S Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S Σ0..1dateThe date of birth for the individual
.... iso21090-verification 0..1CodeableConceptExtension
Binding: QICorePatientVerification (example)
.... value 0..1xs:xs:gYear, xs:gYearMonth, xs:datePrimitive value for date
... deceased[x] ?! SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address Σ0..*AddressAddresses for the individual
.... iso21090-preferred 0..1booleanExtension
.... use ?!0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line 0..*stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city 0..1stringName of city, town etc.
Example: Erewhon
.... state 0..1stringSub-unit of country (abreviations ok)
Binding: QICoreAddressState (preferred)
.... postalCode 0..1stringPostal code for area
Example: 9132
.... country 0..1stringCountry (can be ISO 3166 3 letter code)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: QICoreMaritalStatus (preferred)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: QICorePatientContactRelationship (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1organization-qicore-qicore-organizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*A list of Languages which may be used to communicate with the patient about his or her health
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*organization-qicore-qicore-organization, practitioner-qicore-qicore-practitionerPatient's nominated care provider
... managingOrganization Σ0..1organization-qicore-qicore-organizationOrganization that is the custodian of the patient record
... link ?!0..*Link to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1patient-qicore-qicore-patientThe other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)
... active ?! SΣ0..1booleanWhether this patient's record is in active use

todo

This structure is derived from Patient.

Summary

Mandatory: 3 elements, Must-Support: 5 elements, Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... telecom 0..*
.... iso21090-preferred 0..1booleanpreferred
... gender S
... birthDate S
.... iso21090-verification 0..1CodeableConceptverification
Binding: QICorePatientVerification (example)
... deceased[x] S
... address
.... state Binding: QICoreAddressState (preferred)
.... iso21090-preferred 0..1booleanpreferred
... maritalStatus Binding: QICoreMaritalStatus (preferred)
... contact
.... relationship CodeableConceptBinding: QICorePatientContactRelationship (extensible)
.... organization organization-qicore-qicore-organization
... animal 0..0
... communication
... careProvider organization-qicore-qicore-organization, practitioner-qicore-qicore-practitioner
... managingOrganization organization-qicore-qicore-organization
... link
.... other patient-qicore-qicore-patient
... active S
... us-core-race 0..1CodeableConceptA category of humans sharing history, origin or nationality
Binding: QICoreRace (preferred)
... us-core-ethnicity 0..1CodeableConceptA category of human sharing heritage
Binding: QICoreEthnicity (preferred)
... us-core-religion 0..1CodeableConceptPatient's professed religious affiliation
Binding: DAFReligion (extensible)
... birthPlace 0..1AddressPlace of Birth for patient
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
Binding: QICorePatientDisability (preferred)
... patient-importance 0..1CodeableConceptSpecial status given the patient
Binding: QICorePatientImportance (preferred)
... patient-nationality 0..*(Complex)Nationality
.... patient-nationality-code 1..1CodeableConceptNationality Code
Binding: USCountry (extensible)
.... patient-nationality-period 0..1PeriodNationality Period
... patient-citizenship 0..*(Complex)Nation(s) where the patient claims citizenship
.... patient-citizenship-code 1..1CodeableConceptNation code of citizenship
Binding: USCountry (extensible)
.... patient-citizenship-period 0..1PeriodTime period of citizenship
... patient-cadavericDonor 0..1booleanPost-mortem donor status
... patient-militaryService 0..1CodeableConceptIndicates the current or former military service of the patient
Binding: QICorePatientMilitaryService (example)
... patient-clinicalTrial 0..*(Complex)The patient's participation in clinical trials
.... patient-clinicalTrial-NCT 1..1stringNational Clinical Trial number
.... patient-clinicalTrial-period 0..1PeriodThe period of participation in the clinical trial
.... patient-clinicalTrial-reason 0..1CodeableConceptThe reason for participation in the clinical trial
Binding: QICoreProblemCode (preferred)
... patient-birthTime S0..1dateTimeTime of day of birth

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1PatientInformation about an individual or animal receiving health care services
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race 0..1CodeableConceptExtension
Binding: QICoreRace (preferred)
... us-core-ethnicity 0..1CodeableConceptExtension
Binding: QICoreEthnicity (preferred)
... us-core-religion 0..1CodeableConceptExtension
Binding: DAFReligion (extensible)
... birthPlace 0..1AddressExtension
... patient-disability 0..*CodeableConceptExtension
Binding: QICorePatientDisability (preferred)
... patient-importance 0..1CodeableConceptExtension
Binding: QICorePatientImportance (preferred)
... patient-nationality 0..*(Complex)Extension
.... patient-nationality-code 1..1CodeableConceptExtension
Binding: USCountry (extensible)
.... patient-nationality-period 0..1PeriodExtension
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-citizenship 0..*(Complex)Extension
.... patient-citizenship-code 1..1CodeableConceptExtension
Binding: USCountry (extensible)
.... patient-citizenship-period 0..1PeriodExtension
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-cadavericDonor 0..1booleanExtension
... patient-militaryService 0..1CodeableConceptExtension
Binding: QICorePatientMilitaryService (example)
... patient-clinicalTrial 0..*(Complex)Extension
.... patient-clinicalTrial-NCT 1..1stringExtension
.... patient-clinicalTrial-period 0..1PeriodExtension
.... patient-clinicalTrial-reason 0..1CodeableConceptExtension
Binding: QICoreProblemCode (preferred)
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-birthTime S0..1dateTimeExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAn identifier for this patient
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
.... iso21090-preferred 0..1booleanExtension
.... system I0..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value 0..1stringThe actual contact point details
.... use ?!0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period 0..1PeriodTime period when the contact point was/is in use
... gender S Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S Σ0..1dateThe date of birth for the individual
.... iso21090-verification 0..1CodeableConceptExtension
Binding: QICorePatientVerification (example)
.... value 0..1xs:xs:gYear, xs:gYearMonth, xs:datePrimitive value for date
... deceased[x] ?! SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address Σ0..*AddressAddresses for the individual
.... iso21090-preferred 0..1booleanExtension
.... use ?!0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line 0..*stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city 0..1stringName of city, town etc.
Example: Erewhon
.... state 0..1stringSub-unit of country (abreviations ok)
Binding: QICoreAddressState (preferred)
.... postalCode 0..1stringPostal code for area
Example: 9132
.... country 0..1stringCountry (can be ISO 3166 3 letter code)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: QICoreMaritalStatus (preferred)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: QICorePatientContactRelationship (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1organization-qicore-qicore-organizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*A list of Languages which may be used to communicate with the patient about his or her health
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*organization-qicore-qicore-organization, practitioner-qicore-qicore-practitionerPatient's nominated care provider
... managingOrganization Σ0..1organization-qicore-qicore-organizationOrganization that is the custodian of the patient record
... link ?!0..*Link to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1patient-qicore-qicore-patientThe other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)
... active ?! SΣ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

5.1.1.3.2 Terminology Bindings

PathNameConformanceValueSet
Patient.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-race		QICoreRacepreferredMU Race Value Set
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-ethnicity		QICoreEthnicitypreferredEthnicity group
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-religion		DAFReligionextensiblev3 Code System ReligiousAffiliation
Patient.extension
http://hl7.org/fhir/StructureDefinition/patient-disability		QICorePatientDisabilitypreferredDisability Value Set
Patient.extension
http://hl7.org/fhir/StructureDefinition/patient-importance		QICorePatientImportancepreferredv3 Code System PatientImportance
Patient.extension.extension
http://hl7.org/fhir/StructureDefinition/patient-nationality-code		USCountryextensiblehttp://www.iso.org/iso/country_codes.htm
Patient.extension.extension
http://hl7.org/fhir/StructureDefinition/patient-citizenship-code		USCountryextensiblehttp://www.iso.org/iso/country_codes.htm
Patient.extension
http://hl7.org/fhir/StructureDefinition/patient-militaryService		QICorePatientMilitaryServiceexampleMilitary Service Codes
Patient.extension.extension
http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial-reason		QICoreProblemCodepreferredProblem Value Set
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useContactPointUserequiredContactPointUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.birthDate.extension
http://hl7.org/fhir/StructureDefinition/iso21090-verification		QICorePatientVerificationexampleVerificationMethod
Patient.address.useAddressUserequiredAddressUse
Patient.address.stateQICoreAddressStatepreferredUSPS Two Letter Alphabetic Codes
Patient.maritalStatusQICoreMaritalStatuspreferredv3 Code System MaritalStatus
Patient.contact.relationshipQICorePatientContactRelationshipextensiblePatientContactRelationship
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedexampleAnimalBreeds
Patient.animal.genderStatusAnimalGenderStatusexampleGenderStatus
Patient.communication.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

5.1.1.3.3 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
.