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: DAFPatient

The official URL for this profile is: 

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

. Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information. : U.S. Data Access Framework (DAF) Patient Profile

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

unable to summarise extension (wrong count)

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..1
... identifier S0..*Identifier
.... system S1..1uri
.... value S1..1string
... name S0..*HumanName
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S1..1codeBinding: DAFTelecomUse (required, not extensible)
... gender S0..1codeBinding: AdminstrativeGenderValueset (required, not extensible)
... birthDate S0..1date
... deceased[x] 0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..*string
.... state S1..*stringBinding: DAFStateValueset (required, not extensible)
.... postalCode S1..*string
.... country S1..*string
... maritalStatus S0..1CodeableConceptBinding: DAFMaritalStatus (required, not extensible)
... multipleBirth[x] S0..1boolean, integer
... photo 0..*Attachment
... contact S0..*Element
.... relationship S0..*CodeableConceptBinding: DAFRelationshipValueset (required, not extensible)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
.... gender 0..1code
.... organization 0..1Organization
... animal 0..0=Animal
... communication S0..*CodeableConcept
... careProvider 0..*Organization, Practitioner
... managingOrganization 0..1Organization
... link 0..*
.... other 1..1Patient
.... type 1..1code
... active 0..1boolean
... us-core-race S0..*CodeableConceptA category of humans sharing history, origin or nationality
Binding: DAFRace (required, not extensible)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
Binding: DAFEthnicity (required, not extensible)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
Binding: DAFReligion (preferred, extensible)
... patient-mothers-maiden-name S0..1stringMother's Maiden name
... birthPlace S0..1AddressPlace of Birth for patient

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Information about a person or animal receiving health care services
... 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 S0..*CodeableConceptAdditional Content defined by implementations
Binding: DAFRace (required, not extensible)
... us-core-ethnicity S0..1CodeableConceptAdditional Content defined by implementations
Binding: DAFEthnicity (required, not extensible)
... us-core-religion S0..1CodeableConceptAdditional Content defined by implementations
Binding: DAFReligion (preferred, extensible)
... patient-mothers-maiden-name S0..1stringAdditional Content defined by implementations
... birthPlace S0..1AddressAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S Σ0..*IdentifierAn identifier for the person as this patient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... 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
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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value S1..1stringThe actual contact point details
.... use M S1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: DAFTelecomUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... gender S Σ0..1codemale | female | other | unknown
Binding: AdminstrativeGenderValueset (required, not extensible)
... birthDate S Σ0..1dateThe date of birth for the individual
... birthTime Σ0..1timeThe time of birth for the individual
... deceased[x] M Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
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..*stringName of city, town etc.
Example: Erewhon
.... state S1..*stringSub-unit of country (abreviations ok)
Binding: DAFStateValueset (required, not extensible)
.... postalCode S1..*stringPostal code for area
Example: 9132
.... country S1..*stringCountry (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 S Σ0..1CodeableConceptMarital (civil) status of a person
Binding: DAFMaritalStatus (required, not extensible)
... multipleBirth[x] S Σ0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the person
... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... relationship S0..*CodeableConceptThe kind of relationship
Binding: DAFRelationshipValueset (required, not extensible)
.... name S0..1HumanNameA name associated with the person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... communication S0..*CodeableConceptLanguages which may be used to communicate with the patient about his or her health
Binding: Language (required, not extensible)
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link M Σ0..*Link to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... other M Σ1..1PatientThe other patient resource that the link refers to
.... type M Σ1..1codereplace | refer | seealso - type of link
Binding: LinkType (required, not extensible)
... active M Σ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1
... identifier S0..*Identifier
.... system S1..1uri
.... value S1..1string
... name S0..*HumanName
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S1..1codeBinding: DAFTelecomUse (required, not extensible)
... gender S0..1codeBinding: AdminstrativeGenderValueset (required, not extensible)
... birthDate S0..1date
... deceased[x] 0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..*string
.... state S1..*stringBinding: DAFStateValueset (required, not extensible)
.... postalCode S1..*string
.... country S1..*string
... maritalStatus S0..1CodeableConceptBinding: DAFMaritalStatus (required, not extensible)
... multipleBirth[x] S0..1boolean, integer
... photo 0..*Attachment
... contact S0..*Element
.... relationship S0..*CodeableConceptBinding: DAFRelationshipValueset (required, not extensible)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
.... gender 0..1code
.... organization 0..1Organization
... animal 0..0=Animal
... communication S0..*CodeableConcept
... careProvider 0..*Organization, Practitioner
... managingOrganization 0..1Organization
... link 0..*
.... other 1..1Patient
.... type 1..1code
... active 0..1boolean
... us-core-race S0..*CodeableConceptA category of humans sharing history, origin or nationality
Binding: DAFRace (required, not extensible)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
Binding: DAFEthnicity (required, not extensible)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
Binding: DAFReligion (preferred, extensible)
... patient-mothers-maiden-name S0..1stringMother's Maiden name
... birthPlace S0..1AddressPlace of Birth for patient

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Information about a person or animal receiving health care services
... 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 S0..*CodeableConceptAdditional Content defined by implementations
Binding: DAFRace (required, not extensible)
... us-core-ethnicity S0..1CodeableConceptAdditional Content defined by implementations
Binding: DAFEthnicity (required, not extensible)
... us-core-religion S0..1CodeableConceptAdditional Content defined by implementations
Binding: DAFReligion (preferred, extensible)
... patient-mothers-maiden-name S0..1stringAdditional Content defined by implementations
... birthPlace S0..1AddressAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S Σ0..*IdentifierAn identifier for the person as this patient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... 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
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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value S1..1stringThe actual contact point details
.... use M S1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: DAFTelecomUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... gender S Σ0..1codemale | female | other | unknown
Binding: AdminstrativeGenderValueset (required, not extensible)
... birthDate S Σ0..1dateThe date of birth for the individual
... birthTime Σ0..1timeThe time of birth for the individual
... deceased[x] M Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
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..*stringName of city, town etc.
Example: Erewhon
.... state S1..*stringSub-unit of country (abreviations ok)
Binding: DAFStateValueset (required, not extensible)
.... postalCode S1..*stringPostal code for area
Example: 9132
.... country S1..*stringCountry (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 S Σ0..1CodeableConceptMarital (civil) status of a person
Binding: DAFMaritalStatus (required, not extensible)
... multipleBirth[x] S Σ0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the person
... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... relationship S0..*CodeableConceptThe kind of relationship
Binding: DAFRelationshipValueset (required, not extensible)
.... name S0..1HumanNameA name associated with the person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... communication S0..*CodeableConceptLanguages which may be used to communicate with the patient about his or her health
Binding: Language (required, not extensible)
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link M Σ0..*Link to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... other M Σ1..1PatientThe other patient resource that the link refers to
.... type M Σ1..1codereplace | refer | seealso - type of link
Binding: LinkType (required, not extensible)
... active M Σ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Patient.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.extensionDAFReligionpreferred (extensible)v3 Code System ReligiousAffiliation
Patient.extensionDAFReligionpreferred (extensible)v3 Code System ReligiousAffiliation
Patient.extensionDAFReligionpreferred (extensible)v3 Code System ReligiousAffiliation
Patient.identifier.useIdentifierUserequiredIdentifierUse
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useDAFTelecomUserequiredContactPointUse
Patient.genderAdminstrativeGenderValuesetrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.stateDAFStateValuesetrequiredUSPS Two Letter Alphabetic Codes
Patient.maritalStatusDAFMaritalStatusrequiredv3 Code System MaritalStatus
Patient.contact.relationshipDAFRelationshipValuesetrequiredPersonalRelationshipRoleType
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
.