STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

K.6 StructureDefinition: GAO Patient

The official URL for this profile is: 

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

The patient resource is required to provide relevant demographics associated with the patient. Other details may be provided according to local implementation requirements.

This profile was published on [no date] with unknown status '" by .

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

Summary

Mandatory: 2 elements

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... gender ∑1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑1..1dateThe date of birth for the individual

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierAn identifier for this patient
... active ?! ∑0..1booleanWhether this patient's record is in active use
... name ∑0..*HumanNameA name associated with the patient
... telecom ∑0..*ContactPointA contact detail for the individual
... gender ∑1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑1..1dateThe date of birth for the individual
... deceased[x] ?! ∑0..1boolean, dateTimeIndicates if the individual is deceased or not
... address ∑0..*AddressAddresses for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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: PatientContactRelationship (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..1Reference(Organization)Organization 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
... animal ?! ∑0..1BackboneElementThis patient is known to be an animal (non-human)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... species ∑1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed ∑0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example)
.... genderStatus ∑0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication 0..*BackboneElementA 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: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization ∑0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink 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..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

todo

This structure is derived from Patient.

Summary

Mandatory: 2 elements

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... gender ∑1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑1..1dateThe date of birth for the individual

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierAn identifier for this patient
... active ?! ∑0..1booleanWhether this patient's record is in active use
... name ∑0..*HumanNameA name associated with the patient
... telecom ∑0..*ContactPointA contact detail for the individual
... gender ∑1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑1..1dateThe date of birth for the individual
... deceased[x] ?! ∑0..1boolean, dateTimeIndicates if the individual is deceased or not
... address ∑0..*AddressAddresses for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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: PatientContactRelationship (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..1Reference(Organization)Organization 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
... animal ?! ∑0..1BackboneElementThis patient is known to be an animal (non-human)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... species ∑1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed ∑0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example)
.... genderStatus ∑0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication 0..*BackboneElementA 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: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization ∑0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink 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..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

K.6.2 Terminology Bindings

PathNameConformanceValueSet
Patient.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.maritalStatusMarital Status CodesrequiredMarital Status Codes
Patient.contact.relationshipPatientContactRelationshipextensiblePatientContactRelationship
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedsexampleAnimalBreeds
Patient.animal.genderStatusGenderStatusexampleGenderStatus
Patient.communication.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

K.6.3 Constraints

IdPathDetailsRequirements
pat-1Patient.contactSHALL 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
.