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.14.6 StructureDefinition: DAFPatient

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/patient-daf-dafpatient

Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information.

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... identifier S1..*Identifier
.... type S0..1CodeableConceptDescription of identifier
.... system S1..1uri
.... value S1..1stringThe value that is unique within the system.
... name S0..*HumanName
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S1..1code
... gender S0..1codeBinding: AdminstrativeGender (required)
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..1string
.... state S1..1stringBinding: DAFUSPSState (required)
.... postalCode S I1..1stringinv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S1..1string
... maritalStatus S0..1CodeableConceptBinding: DAFMaritalStatus (required)
... multipleBirth[x] S0..1boolean, integer
... contact S0..*Element
.... relationship S0..*CodeableConceptBinding: ContactRelationships (extensible)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
..... use S0..1
..... line S0..2
..... city S0..1
..... state S0..1Binding: DAFUSPSState (required)
..... postalCode S I0..1inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
..... country S0..1ISO 3166 3 letter Country Code
Binding: USCountry (extensible)
... animal 0..0=Animal
... communication S0..*
.... language S1..1CodeableConcept
... careProvider S0..*org-daf-daforganization, pract-daf-dafpract
... managingOrganization S0..1org-daf-daforganization
... active S0..1boolean
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
Binding: DAFRace (required)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
Binding: DAFEthnicity (required)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
Binding: DAFReligion (extensible)
... patient-mothersMaidenName S0..1stringMother's Maiden name
... birthPlace S0..1AddressPlace of Birth for patient
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 S0..1CodeableConceptExtension
Binding: DAFRace (required)
... us-core-ethnicity S0..1CodeableConceptExtension
Binding: DAFEthnicity (required)
... us-core-religion S0..1CodeableConceptExtension
Binding: DAFReligion (extensible)
... patient-mothersMaidenName S0..1stringExtension
... birthPlace S0..1AddressExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S Σ1..*IdentifierAn identifier for this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type S0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringThe value that is unique within the system.
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S Σ0..*HumanNameA name associated with the patient
... telecom S Σ0..*ContactPointA contact detail for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?! S1..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: AdminstrativeGender (required)
... birthDate S Σ0..1dateThe date of birth for the individual
... deceased[x] ?! SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... 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 S1..*stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S1..1stringName of city, town etc.
Example: Erewhon
.... state S1..1stringSub-unit of country (abreviations ok)
Binding: DAFUSPSState (required)
.... postalCode S I1..1stringPostal code for area
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S1..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 S0..1CodeableConceptMarital (civil) status of a patient
Binding: DAFMaritalStatus (required)
... multipleBirth[x] S0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact S I0..*ElementA 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 S0..*CodeableConceptThe kind of relationship
Binding: ContactRelationships (extensible)
.... name S0..1HumanNameA name associated with the contact person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?! S0..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 S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
..... city S0..1stringName of city, town etc.
Example: Erewhon
..... state S0..1stringSub-unit of country (abreviations ok)
Binding: DAFUSPSState (required)
..... postalCode S I0..1stringPostal code for area
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
..... country S0..1stringISO 3166 3 letter Country Code
Binding: USCountry (extensible)
..... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1OrganizationOrganization 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 S0..*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 S1..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 S0..*org-daf-daforganization, pract-daf-dafpractPatient's nominated care provider
... managingOrganization S Σ0..1org-daf-daforganizationOrganization 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..1PatientThe 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

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... identifier S1..*Identifier
.... type S0..1CodeableConceptDescription of identifier
.... system S1..1uri
.... value S1..1stringThe value that is unique within the system.
... name S0..*HumanName
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S1..1code
... gender S0..1codeBinding: AdminstrativeGender (required)
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..1string
.... state S1..1stringBinding: DAFUSPSState (required)
.... postalCode S I1..1stringinv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S1..1string
... maritalStatus S0..1CodeableConceptBinding: DAFMaritalStatus (required)
... multipleBirth[x] S0..1boolean, integer
... contact S0..*Element
.... relationship S0..*CodeableConceptBinding: ContactRelationships (extensible)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
..... use S0..1
..... line S0..2
..... city S0..1
..... state S0..1Binding: DAFUSPSState (required)
..... postalCode S I0..1inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
..... country S0..1ISO 3166 3 letter Country Code
Binding: USCountry (extensible)
... animal 0..0=Animal
... communication S0..*
.... language S1..1CodeableConcept
... careProvider S0..*org-daf-daforganization, pract-daf-dafpract
... managingOrganization S0..1org-daf-daforganization
... active S0..1boolean
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
Binding: DAFRace (required)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
Binding: DAFEthnicity (required)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
Binding: DAFReligion (extensible)
... patient-mothersMaidenName S0..1stringMother's Maiden name
... birthPlace S0..1AddressPlace of Birth for patient

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 S0..1CodeableConceptExtension
Binding: DAFRace (required)
... us-core-ethnicity S0..1CodeableConceptExtension
Binding: DAFEthnicity (required)
... us-core-religion S0..1CodeableConceptExtension
Binding: DAFReligion (extensible)
... patient-mothersMaidenName S0..1stringExtension
... birthPlace S0..1AddressExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S Σ1..*IdentifierAn identifier for this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type S0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringThe value that is unique within the system.
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S Σ0..*HumanNameA name associated with the patient
... telecom S Σ0..*ContactPointA contact detail for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?! S1..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: AdminstrativeGender (required)
... birthDate S Σ0..1dateThe date of birth for the individual
... deceased[x] ?! SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... 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 S1..*stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S1..1stringName of city, town etc.
Example: Erewhon
.... state S1..1stringSub-unit of country (abreviations ok)
Binding: DAFUSPSState (required)
.... postalCode S I1..1stringPostal code for area
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S1..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 S0..1CodeableConceptMarital (civil) status of a patient
Binding: DAFMaritalStatus (required)
... multipleBirth[x] S0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact S I0..*ElementA 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 S0..*CodeableConceptThe kind of relationship
Binding: ContactRelationships (extensible)
.... name S0..1HumanNameA name associated with the contact person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?! S0..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 S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
..... city S0..1stringName of city, town etc.
Example: Erewhon
..... state S0..1stringSub-unit of country (abreviations ok)
Binding: DAFUSPSState (required)
..... postalCode S I0..1stringPostal code for area
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
..... country S0..1stringISO 3166 3 letter Country Code
Binding: USCountry (extensible)
..... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1OrganizationOrganization 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 S0..*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 S1..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 S0..*org-daf-daforganization, pract-daf-dafpractPatient's nominated care provider
... managingOrganization S Σ0..1org-daf-daforganizationOrganization 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..1PatientThe 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.14.6.2 Terminology Bindings

PathNameConformanceValueSet
Patient.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-race		DAFRacerequiredMU Race Value Set
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-ethnicity		DAFEthnicityrequiredEthnicity group
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-religion		DAFReligionextensiblev3 Code System ReligiousAffiliation
Patient.identifier.useIdentifierUserequiredIdentifierUse
Patient.identifier.typeIdentifierTypeextensibleIdentifier Type Codes
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useContactPointUserequiredContactPointUse
Patient.genderAdminstrativeGenderrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.stateDAFUSPSStaterequiredUSPS Two Letter Alphabetic Codes
Patient.maritalStatusDAFMaritalStatusrequiredv3 Code System MaritalStatus
Patient.contact.relationshipContactRelationshipsextensiblePatientContactRelationship
Patient.contact.address.useAddressUserequiredAddressUse
Patient.contact.address.stateDAFUSPSStaterequiredUSPS Two Letter Alphabetic Codes
Patient.contact.address.countryUSCountryextensiblehttp://www.iso.org/iso/country_codes.htm
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.14.6.3 Constraints

IdPathNameDetails
inv-1Patient.address.postalCodeRegex for Zip(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
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
inv-2Patient.contact.address.postalCodeRegex for Zip(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
.